IRironcladapp
Workflows

Delete Signer

Changed on

Deletes a signer from a signature packet, as specified by the signerRoleName parameter.

OAuth Scope required: public.workflows.deleteSigners

NOTE: Removing a signer will cancel the current packet that is out collecting signatures.

delete/workflows/{id}/sign-status/signers/{signerRoleName}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}/sign-status/signers/{signerRoleName}
  • 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.deleteSigners

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

signerRoleNamestring required

The role name of the signer to be removed. Note: the role name should be URL encoded in the URL.

Query parameters

muteCancellationNotificationsboolean

Removing a signer from a packet that is out for signature cancels the in-flight request and issues a new one. When true, the eSignature provider does not email signers about that cancellation. 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.

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.

Response

204

Changes