Cancel Signature Request

post

https://na1.ironcladapp.com/public/api/v1/workflows/{id}/sign-status/cancel-signature-request

Cancel a signature request that was out for signature.

OAuth Scope required: public.workflows.cancelSignatureRequests

Path Params

string

required

The unique identifier or Ironclad ID of a workflow.

Body Params

reason

string

required

The reason for canceling the signature request.

Headers

x-as-user-email

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-id

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

401401

404404 not found