Update Signature Packet on a Workflow

patch

https://na1.ironcladapp.com/public/api/v1/workflows/{id}/signature-packet

Update a workflow's signature packet by moving documents into it, moving documents out of it, or reordering documents within it. The request body specifies which workflow documents should be in the signature packet and their order. Documents in the request but not currently in the signature packet will be moved into it. Documents currently in the signature packet but not in the request will be moved out of it.

Note: Only editable file types (.doc, .docx, .pdf) can be included in the signature packet.

Restrictions:

Workflow must be at Review stage
All document keys must be valid editable documents on the workflow

OAuth Scope required: public.workflows.updateSignaturePacket

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique identifier or Ironclad ID of a workflow.

Body Params

signaturePacketDocumentKeys

array of strings

required

Array of document keys representing the desired signature packet order. Only editable file types (.doc, .docx, .pdf) are valid. Cannot be empty if the workflow has a sign step configured.

signaturePacketDocumentKeys*

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

401401

403403

404404