---
title: "Update envelope"
method: POST
path: "/envelope/update"
tags: ["Envelope"]
---

# Update envelope

`POST /envelope/update`

## Request body

- object
  - `envelopeId` string, required
  - `data` object
    - `title` string
    - `externalId` string, nullable
    - `visibility` 'EVERYONE' | 'MANAGER_AND_ABOVE' | 'ADMIN'
    - `globalAccessAuth` string[]
    - `globalActionAuth` string[]
    - `folderId` string, nullable
    - `templateType` 'PUBLIC' | 'PRIVATE' | 'ORGANISATION'
  - `meta` object
    - `subject` string
    - `message` string
    - `timezone` string
    - `dateFormat` 'yyyy-MM-dd hh:mm a' | 'yyyy-MM-dd' | 'dd/MM/yyyy' | 'dd-MM-yyyy' | 'MM/dd/yyyy' | 'yy-MM-dd' | 'MMMM dd, yyyy' | 'EEEE, MMMM dd, yyyy' | 'dd/MM/yyyy hh:mm a' | 'dd/MM/yyyy HH:mm' | 'dd-MM-yyyy hh:mm a' | 'dd-MM-yyyy HH:mm' | 'MM/dd/yyyy hh:mm a' | 'MM/dd/yyyy HH:mm' | 'dd.MM.yyyy' | 'dd.MM.yyyy HH:mm' | 'yyyy-MM-dd HH:mm' | 'yy-MM-dd hh:mm a' | 'yy-MM-dd HH:mm' | 'yyyy-MM-dd HH:mm:ss' | 'MMMM dd, yyyy hh:mm a' | 'MMMM dd, yyyy HH:mm' | 'EEEE, MMMM dd, yyyy hh:mm a' | 'EEEE, MMMM dd, yyyy HH:mm' | 'yyyy-MM-dd'T'HH:mm:ss.SSSXXX'
    - `distributionMethod` 'EMAIL' | 'NONE'
    - `signingOrder` 'PARALLEL' | 'SEQUENTIAL'
    - `allowDictateNextSigner` boolean
    - `redirectUrl` string
    - `language` 'de' | 'en' | 'fr' | 'es' | 'it' | 'nl' | 'pl' | 'pt-BR' | 'ja' | 'ko' | 'zh'
    - `typedSignatureEnabled` boolean
    - `uploadSignatureEnabled` boolean
    - `drawSignatureEnabled` boolean
    - `emailId` string, nullable
    - `emailReplyTo` string, nullable
    - `emailSettings` object, nullable
      - `recipientSigningRequest` boolean
      - `recipientRemoved` boolean
      - `recipientSigned` boolean
      - `documentPending` boolean
      - `documentCompleted` boolean
      - `documentDeleted` boolean
      - `ownerDocumentCompleted` boolean
      - `ownerRecipientExpired` boolean
      - `ownerDocumentCreated` boolean
    - `envelopeExpirationPeriod` union
      - object
        - `unit` 'day' | 'week' | 'month' | 'year', required
        - `amount` integer, required
      - object
        - `disabled` true, required
    - `reminderSettings` object, nullable
      - `sendAfter` union, required
        - object
          - `unit` 'day' | 'week' | 'month', required
          - `amount` integer, required
        - object
          - `disabled` true, required
      - `repeatEvery` union, required
        - object
          - `unit` 'day' | 'week' | 'month', required
          - `amount` integer, required
        - object
          - `disabled` true, required

## Response `200`

Successful response

- object
  - `internalVersion` number, required
  - `type` 'DOCUMENT' | 'TEMPLATE', required
  - `status` 'DRAFT' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'CANCELLED', required
  - `source` 'DOCUMENT' | 'TEMPLATE' | 'TEMPLATE_DIRECT_LINK', required
  - `visibility` 'EVERYONE' | 'MANAGER_AND_ABOVE' | 'ADMIN', required
  - `templateType` 'PUBLIC' | 'PRIVATE' | 'ORGANISATION', required
  - `id` string, required
  - `secondaryId` string, required
  - `externalId` string, nullable, required
  - `createdAt` string, required
  - `updatedAt` string, required
  - `completedAt` string, nullable, required
  - `deletedAt` string, nullable, required
  - `title` string, required
  - `authOptions` object, nullable, required
    - `globalAccessAuth` string[], required
    - `globalActionAuth` string[], required
  - `formValues` object, nullable, required
  - `publicTitle` string, required
  - `publicDescription` string, required
  - `userId` number, required
  - `teamId` number, required
  - `folderId` string, nullable, required

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `500` — Internal server error

---

[API](https://skmtc.net/documenso/apis/documenso-v2-api.md) · [All operations](https://skmtc.net/documenso/apis/documenso-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/documenso/documenso-v2-api/revisions/3db245102197/schema)