Update Signer

patch

https://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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

signsOutsideIronclad

boolean

Indicates whether this signer signs outside of Ironclad. When true, the signer is excluded from the eSignature request and the workflow waits for their signature to be uploaded instead of auto-advancing.

muteCancellationNotifications

boolean

Updating a signer on 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-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. 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-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. 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.

Responses

Language

Credentials

URL

Loading…

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