IRironcladapp
Workflows

Update Signature Packet on a Workflow

Changed on

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

patch/workflows/{id}/signature-packet

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}/signature-packet
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.workflows.updateSignaturePacket

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

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. 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-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. 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.

Request body

signaturePacketDocumentKeysstring[] 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.

Response

200

Example response

{
  "signaturePacketDocuments": [
    {
      "version": "B1QePArXb",
      "versionNumber": 2,
      "filename": "file.pdf",
      "key": "rJklwCHQ",
      "download": "/public/api/v1/workflows/594356b9fbcd7f74006fdf8a/document/rJklwCHQ/download",
      "lastModified": {
        "timestamp": "2016-11-17T00:37:22.318Z",
        "author": {
          "type": "internalUser",
          "companyName": "Jabba the Hutt Industries",
          "displayName": "Boba Fett",
          "email": "boba@example.com",
          "userId": "63d415e0dd0d828c3a878548"
        }
      },
      "fileHash": "2fd4e1c67a2d28fced849ee1bb76e7391b93eb12",
      "hashAlgorithm": "sha1"
    }
  ],
  "excludedFromSignaturePacketDocuments": [
    {
      "version": "B1QePArXb",
      "versionNumber": 2,
      "filename": "file.pdf",
      "key": "rJklwCHQ",
      "download": "/public/api/v1/workflows/594356b9fbcd7f74006fdf8a/document/rJklwCHQ/download",
      "lastModified": {
        "timestamp": "2016-11-17T00:37:22.318Z",
        "author": {
          "type": "internalUser",
          "companyName": "Jabba the Hutt Industries",
          "displayName": "Boba Fett",
          "email": "boba@example.com",
          "userId": "63d415e0dd0d828c3a878548"
        }
      },
      "fileHash": "2fd4e1c67a2d28fced849ee1bb76e7391b93eb12",
      "hashAlgorithm": "sha1"
    }
  ]
}

Changes

  • 435da5a4396eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status