Box Developerドキュメント
ログイン
最新バージョン

Box Signリクエストをキャンセル

post
https://api.box.com/2.0
/sign_requests/:sign_request_id/cancel

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

署名リクエストをキャンセルします。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
33243242

署名リクエストのID。

レスポンス

application/jsonBox Signリクエスト

署名リクエストオブジェクトを返します。

application/jsonクライアントエラー

署名リクエストが見つからない場合、またはユーザーが署名リクエストにアクセスできない場合はエラーを返します。

application/jsonクライアントエラー

予期しないクライアントエラー。

post
Box Signリクエストをキャンセル
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X POST "https://api.box.com/2.0/sign_requests/<SIGN_REQUEST_ID>/cancel" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.signRequests.cancelSignRequest(createdSignRequest.id!);
Python Gen
client.sign_requests.cancel_sign_request(created_sign_request.id)
.NET Gen
await client.SignRequests.CancelSignRequestAsync(signRequestId: NullableUtils.Unwrap(createdSignRequest.Id));
Java
BoxSignRequest signRequest = new BoxSignRequest(api, id);
BoxSignRequest.Info signRequestInfo = signRequest.getInfo();

signRequestInfo.cancel();
Python
sign_request = client.sign_request(sign_request_id='12345')
cancelled_sign_request = sign_request.cancel()
print(f'Cancelled Sign Request status is {cancelled_sign_request.status}')
.NET
BoxSignRequest cancelledSignRequest = await client.SignRequestsManager.CancelSignRequestAsync("12345");
Node
const signRequest = await client.signRequests.cancelById({
	sign_request_id: 12345,
});
console.log(`Sign request id ${sr.id} cancelled`);

レスポンスの例

{
  "id": "12345",
  "type": "sign-request",
  "are_reminders_enabled": true,
  "are_text_signatures_enabled": true,
  "auto_expire_at": "2021-04-26T08:12:13.982Z",
  "collaborator_level": "owner",
  "days_valid": 2,
  "declined_redirect_url": "https://declined-redirect.com",
  "email_message": "Hello! Please sign the document below",
  "email_subject": "Sign Request from Acme",
  "external_id": "123",
  "external_system_name": "Box",
  "is_document_preparation_needed": true,
  "name": "name",
  "parent_folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "prefill_tags": [
    {
      "checkbox_value": true,
      "date_value": "2021-04-26",
      "document_tag_id": "1234",
      "text_value": "text"
    }
  ],
  "prepare_url": "https://prepareurl.com",
  "redirect_url": "https://www.example.com",
  "sender_email": "sender@box.com",
  "sender_id": 12345,
  "sign_files": {
    "files": [
      {
        "etag": "1",
        "id": "12345",
        "type": "file",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        },
        "name": "Contract.pdf",
        "sequence_id": "3",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
      }
    ],
    "is_ready_for_download": true
  },
  "signature_color": "blue",
  "signers": [
    {
      "declined_redirect_url": "https://declined-example.com",
      "email": "example@gmail.com",
      "embed_url_external_user_id": "1234",
      "is_in_person": true,
      "login_required": true,
      "order": 2,
      "password": "SecretPassword123",
      "redirect_url": "https://example.com",
      "role": "signer",
      "signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
      "suppress_notifications": false,
      "verification_phone_number": "6314578901",
      "embed_url": "https://example.com",
      "has_viewed_document": true,
      "iframeable_embed_url": "https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4",
      "inputs": [
        {
          "checkbox_value": true,
          "date_value": "2021-04-26",
          "document_tag_id": "1234",
          "text_value": "text",
          "content_type": "signature",
          "page_index": 4,
          "read_only": true,
          "type": "text"
        }
      ],
      "signer_decision": {
        "additional_info": "Requesting changes before signing.",
        "finalized_at": "2021-04-26T08:12:13.982Z",
        "type": "signed"
      }
    }
  ],
  "signing_log": {
    "id": "12345",
    "type": "file",
    "etag": "1",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "name": "Contract.pdf",
    "sequence_id": "3",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
  },
  "source_files": [
    {
      "etag": "1",
      "id": "12345",
      "type": "file"
    }
  ],
  "status": "converting",
  "template_id": "123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb"
}