Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Workflows

Update Signer

Reassign a signer or edit an external signer's name or email, as specified by the signerRoleName parameter. The original signer will receive an email that the packet has been reassigned if it was sent out for signature.

OAuth Scope required: public.workflows.updateSigners

NOTE: Editing a signer will not cancel a signature request unless your configured signature provider is Adobe Sign. Also, you cannot update a signer that has already signed via the API for any signature provider.

patch/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 updated. 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.

Request body

OR

Example request

{
  "reason": "Because I need someone from legal to sign instead.",
  "assigned": {
    "type": "internal",
    "userId": "63d415e0dd0d828c3a878548"
  }
}

Response

200

OR

Example response

{
  "name": "Jane Doe",
  "email": "janedoe@example.com",
  "roleName": "Counterparty Signer",
  "status": "pending",
  "delegates": [
    {
      "name": "Kim Lam",
      "email": "kimlam@example.com"
    }
  ],
  "routingOrder": 1,
  "type": "internal",
  "userId": "63d415e0dd0d828c3a878548"
}