Cancel Box Sign Request
Cancel Box Sign Request
A Box Sign request, that has not yet been signed or declined, can be cancelled using the cancel Box Sign request endpoint. Any outstanding signers will no longer be able to sign the document.
Only the user who created the request, the requester, is able to cancel it. A request cannot be cancelled if it was declined, fully signed, or the document is still converting.
cURL
curl -i -X POST "https://api.box.com/2.0/sign_requests/<SIGN_REQUEST_ID>/cancel" \
-H "authorization: Bearer <ACCESS_TOKEN>"Node/TypeScript v10
await client.signRequests.cancelSignRequest(createdSignRequest.id!);Python v10
client.sign_requests.cancel_sign_request(created_sign_request.id).NET v10
await client.SignRequests.CancelSignRequestAsync(signRequestId: NullableUtils.Unwrap(createdSignRequest.Id));Swift v10
try await client.signRequests.cancelSignRequest(signRequestId: createdSignRequest.id!)Java v10
client.getSignRequests().cancelSignRequest(createdSignRequest.getId())Java v4
BoxSignRequest signRequest = new BoxSignRequest(api, id);
BoxSignRequest.Info signRequestInfo = signRequest.getInfo();
signRequestInfo.cancel();Python v3
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 v5
BoxSignRequest cancelledSignRequest = await client.SignRequestsManager.CancelSignRequestAsync("12345");Node v3
const signRequest = await client.signRequests.cancelById({
sign_request_id: 12345,
});
console.log(`Sign request id ${sr.id} cancelled`);