---
title: "Update Signature Packet on a Workflow"
method: PATCH
path: "/workflows/{id}/signature-packet"
tags: ["Workflows"]
---

# Update Signature Packet on a Workflow

`PATCH /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`

## Path parameters

- `id` string, required

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Request body

- object
  - `signaturePacketDocumentKeys` string[], 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`

200

- object
  - `signaturePacketDocuments` WorkflowDocumentModel[], required — The signature packet documents in the updated order.
    - `version` string, required — The version ID of the document's latest version
    - `versionNumber` number, required — The latest version number of the document
    - `filename` string, required — The name of the document with the extension
    - `key` string, required — The unique key associated with the document
    - `download` string, required — The URL to download the document omitting the base URL
    - `lastModified` object — The timestamp and author of the last modification to the document
      - `timestamp` string, required — The timestamp of the last modification to the document (ISO 8601 format)
      - `author` union — The author of an activity feed item
        - object — An internal author of an activity feed item
          - `type` 'internalUser', required — The type of author
          - `companyName` string, required — The company name of the author
          - `displayName` string — The display name of the author
          - `email` string — The email of the author
          - `userId` string — The user ID of the author
        - object — An external author of an activity feed item (typically a counterparty)
          - `type` 'externalUser', required — The type of author
          - `companyName` string, required — The company name of the author
          - `displayName` string — The display name of the author
          - `email` string — The email of the author
        - object — An integration author of an activity feed item
          - `type` 'integration', required — The type of author
          - `displayName` string, required — The display name of the integration
        - object — A system author of an activity feed item
          - `type` 'system', required — The type of author
          - `displayName` 'Ironclad', required — The display name of the system
  - `excludedFromSignaturePacketDocuments` WorkflowDocumentModel[], required — The documents that are excluded from the signature packet.
    - `version` string, required — The version ID of the document's latest version
    - `versionNumber` number, required — The latest version number of the document
    - `filename` string, required — The name of the document with the extension
    - `key` string, required — The unique key associated with the document
    - `download` string, required — The URL to download the document omitting the base URL
    - `lastModified` object — The timestamp and author of the last modification to the document
      - `timestamp` string, required — The timestamp of the last modification to the document (ISO 8601 format)
      - `author` union — The author of an activity feed item
        - object — An internal author of an activity feed item
          - `type` 'internalUser', required — The type of author
          - `companyName` string, required — The company name of the author
          - `displayName` string — The display name of the author
          - `email` string — The email of the author
          - `userId` string — The user ID of the author
        - object — An external author of an activity feed item (typically a counterparty)
          - `type` 'externalUser', required — The type of author
          - `companyName` string, required — The company name of the author
          - `displayName` string — The display name of the author
          - `email` string — The email of the author
        - object — An integration author of an activity feed item
          - `type` 'integration', required — The type of author
          - `displayName` string, required — The display name of the integration
        - object — A system author of an activity feed item
          - `type` 'system', required — The type of author
          - `displayName` 'Ironclad', required — The display name of the system

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)