Skip to content

Update envelope

Request

Updates a specific envelope.

Security
Bearer or PersonalAccessToken
Path
organizationIdstring, (uuid)required

Unique identifier of the organization

envelopeIdstring, (uuid)required

Unique identifier of the envelope

Bodyapplication/jsonrequired
namestringrequired

The envelope name.

Example:"Updated contract name"
expirationAbsoluteUpdateEnvelopeExpirationRequest (object) or RelativeUpdateEnvelopeExpirationRequest (object)required
One of:

Absolute expiration configuration.

reminderobject(UpdateEnvelopeReminderRequest)required

Reminder configuration.

qualifiedTimeStampboolean or null

Whether all signatures in the envelope must use a qualified timestamp server. Optional. When omitted, the value false is applied at the downstream Nova boundary.

Example:true
signatureReasonstring or null

The signature reason persisted on the envelope. Null or omitted overwrites the persisted value to null (full PUT semantics).

Example:"Approved by Mario Rossi"
signatureFormatstring(SignatureFormat)

The signature format for an envelope or template.

Enum:"Pades""Cades"
agreementsArray of objects or null(Agreement)

The agreements per language. Null means no change (keep existing); empty list clears all agreements.

fileRestrictedVisibilityboolean or null

Whether file visibility is restricted per recipient. Null means no change.

Example:false
afterSendRedirectUrlstring or null

The URL to redirect to after sending the envelope. Null or omitted overwrites the persisted value to null (full PUT semantics).

Example:"https://example.com/envelope-sent"
PUT
/api/v1/organizations/{organizationId}/envelopes/{envelopeId}
curl -i -X PUT \
  '/api/v1/organizations/{organizationId}/envelopes/{envelopeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated contract name",
    "expiration": {
      "mode": "Absolute",
      "expiresAt": "2026-12-11T14:00:03.184352+00:00"
    },
    "reminder": {
      "enabled": true,
      "firstReminderInDays": 5,
      "resendIntervalInDays": 3,
      "beforeExpirationInDays": 2
    },
    "qualifiedTimeStamp": true,
    "signatureReason": "Approved by Mario Rossi",
    "afterSendRedirectUrl": "https://example.com/envelope-sent"
  }'

Responses

No Content

Response
No content