Update Signer

patch

https://na1.ironcladapp.com/public/api/v1/workflows/{id}/sign-status/signers/{signerRoleName}

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.

Path Params

string

required

The unique identifier or Ironclad ID of a workflow.

signerRoleName

string

required

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

Body Params

reason

string

required

The reason for updating the signer.

assigned

object

required

Indicates the signer that you want to assign to the given role.

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