IRironcladapp
Workflows

Cancel Signature Request

Changed on

Cancel a signature request that was out for signature.

OAuth Scope required: public.workflows.cancelSignatureRequests

post/workflows/{id}/sign-status/cancel-signature-request

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}/sign-status/cancel-signature-request
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.workflows.cancelSignatureRequests

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Request body

reasonstring required

The reason for canceling the signature request.

muteCancellationNotificationsboolean

When true, the eSignature provider does not email signers to tell them the request was canceled. Only supported for Ironclad Signature and Adobe Sign: DocuSign cannot suppress cancellation emails, and Dropbox Sign does not send one. Returns a 400 INVALID_PARAM error when set to true and the provider holding the in-flight request does not support it. Ignored when no request is out for signature.

Example request

{
  "reason": "Need to make changes.",
  "muteCancellationNotifications": true
}

Response

200

routing'sequential' | 'parallel'

Indicates if routing is sequential (signatures collected in order) or parallel (all signers receive request simultaneously).

status'not_sent' | 'sent' | 'action_required' | 'complete'

Indicates the status of the signature request. NOTE: If status is 'action_required,' that means signature tags are missing for document.

requireSignedDocumentUploadboolean

Indicates if the document requires a signed document to be uploaded.

provider'Ironclad Clickwrap' | 'Ironclad Signature' | 'Ironclad Signature (Legacy)' | 'DocuSign' | 'Adobe Sign' | 'DropboxSign' | 'Custom Provider' | 'Demo' | 'None'

Indicates the signature provider used for the signature request, if any.

Example response

{
  "signers": [
    {
      "name": "Jane Doe",
      "email": "janedoe@example.com",
      "roleName": "Counterparty Signer",
      "status": "pending",
      "delegates": [
        {
          "name": "Kim Lam",
          "email": "kimlam@example.com"
        }
      ],
      "routingOrder": 1,
      "signsOutsideIronclad": true,
      "type": "internal",
      "userId": "63d415e0dd0d828c3a878548"
    }
  ],
  "routing": "sequential",
  "status": "sent",
  "provider": "Ironclad Signature"
}

Changes

  • 435da5a4396eRevision changes
    • warning

      added the new Custom Provider enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status