Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Cancel Box Sign request
Cancels a sign request.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
33243242The ID of the signature request
Response
application/jsonBox Sign request
Returns a Sign Request object.
application/jsonClient error
Returns an error when the sign request cannot be found or the user does not have access to the sign request.
application/jsonClient error
An unexpected client error.
Request Example
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));Swift Gen (Beta)
try await client.signRequests.cancelSignRequest(signRequestId: 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`);iOS
client.signRequests.cancelById(id: "1234") { (result: Result<SignRequest, BoxSDKError>) in
guard case let .success(signRequest) = result else {
print("Error cancelling sign request")
return
}
print("Sign request \(signRequest.id) is cancelled")
}Response Example
{
"id": "12345",
"type": "sign-request",
"are_reminders_enabled": true,
"are_text_signatures_enabled": true,
"auto_expire_at": "2021-04-26T08:12:13.982Z",
"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,
"is_phone_verification_required_to_view": true,
"name": "name",
"parent_folder": {
"id": "12345",
"type": "folder",
"etag": "1",
"name": "Contracts",
"sequence_id": "3"
},
"prefill_tags": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26"
}
],
"prepare_url": "https://prepareurl.com",
"redirect_url": "https://www.example.com",
"sign_files": {
"files": [
{
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}
}
],
"is_ready_for_download": true
},
"signature_color": "blue",
"signers": [
{
"email": "example@gmail.com",
"role": "signer",
"is_in_person": true,
"order": 2,
"embed_url_external_user_id": "1234",
"redirect_url": "https://example.com",
"declined_redirect_url": "https://declined-example.com",
"login_required": true,
"verification_phone_number": "6314578901",
"password": "SecretPassword123",
"signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"suppress_notifications": false,
"has_viewed_document": true,
"signer_decision": {
"type": "signed",
"finalized_at": "2021-04-26T08:12:13.982Z",
"additional_info": "Requesting changes before signing."
},
"inputs": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26",
"type": "text",
"content_type": "signature",
"page_index": 4,
"read_only": true
}
],
"embed_url": "https://example.com",
"iframeable_embed_url": "https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4"
}
],
"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": [
{
"id": "12345",
"etag": "1",
"type": "file"
}
],
"status": "converting",
"template_id": "123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb"
}