Cancel Box Sign Request

Guides Box Sign 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>"

.NET

BoxSignRequest cancelledSignRequest = await client.SignRequestsManager.CancelSignRequestAsync("12345");

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}')

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")
}

TypeScript (Beta)

await client.signRequests.cancelSignRequest(createdSignRequest.id!);

Python (Beta)

client.sign_requests.cancel_sign_request(created_sign_request.id)

.NET (Beta)

await client.SignRequests.CancelSignRequestAsync(signRequestId: NullableUtils.Unwrap(createdSignRequest.Id));