v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Workflows

Delete Signer

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}

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.

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. 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. More information about permissions.

Response

204