Skip to Content

Update a document

You're viewing API version 2026-09, which is deprecated and stops working on October 1, 2027. To move your integration, see Upgrading to 2026-10.
PATCH
/api/v1/documents/{id}

Update document properties. A DRAFT document accepts every field. After sending, what you can change depends on the field, and a locked field returns 400 with the reason.

Updatable Fields:

  • name - Document title
  • externalId - Your external reference ID
  • expiresAt - Document expiration date
  • responsibleUserId - User ID of responsible team member (must be in your organization)
  • documentMeta - Metadata including subject, message, and signing order
  • customFields - Custom field values

Per-Signer Settings: Delivery method and signature type are configured per-signer via the signers endpoint, not at the document level.

After sending:

  • name, externalId, responsibleUserId, value and documentCategoryId can always change.
  • Reminders, subject, message, redirect, chat, delegation, internal recipients and signableAfterExpired can change until the document is completed, cancelled or rejected.
  • expiresAt moves the deadline (at least 24 hours ahead) and notifies the parties, like POST /api/v1/documents/{id}/extend-expiration.
  • accessVerification, forceReadFullDocument and preferredLanguage can change until someone has signed.
  • signingOrder, ssnDisplayMode, sameDeviceSigning and documentStyle can't change; withdraw the document first.

Authorization

headerAuthorizationBearer <token>

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Path Parameters

id*string

Header Parameters

authorization*string

Bearer token for API authentication

Idempotency-Key?string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Lengthlength <= 255

Request Body

Body

application/json
  1. body
name?string
externalId?string
expiresAt?unknown
responsibleUserId?string

User ID of the person responsible for this document. Must be a member of your organization.

documentMeta?
documentStyle?

Document styling configuration including orientation, padding, background, and layout

customFields?array<>

Response Body

200

application/json
  1. response
id*string

Unique document identifier

externalId?|

Your external reference ID for this document

expiresAt?|

Date and time when the document expires

Formatdate-time
name*string

Document name/title

status*string

Document status: DRAFT, SENDING, PENDING, COMPLETED, EXPIRED, CANCELLED, or IMPORTED

documentMeta?|

Document metadata including subject, message, signing order, etc.

createdAt*string

Date and time when the document was created

Formatdate-time
updatedAt*string

Date and time when the document was last updated

Formatdate-time
completedAt?|

Date and time when all signers completed signing

Formatdate-time
Example Request
curl -X PATCH 'https://app.sajn.se/api/v1/documents/string' \  -H 'authorization: string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "externalId": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "name": "string",  "status": "string",  "documentMeta": {    "subject": "string",    "message": "string",    "signingOrder": "PARALLEL",    "forceReadFullDocument": true,    "showChatToSigners": true,    "preferredLanguage": "sv",    "value": "string",    "redirectUrl": "string",    "redirectEnabled": true,    "internalRecipients": [      "string"    ],    "signableAfterExpired": true,    "sendPlainTextEmailOnly": true,    "reminderIntervalDays": "string",    "allowDelegation": true,    "accessVerification": "NONE",    "aiChatEnabled": true,    "ssnDisplayMode": "FULL",    "sameDeviceSigning": true,    "documentCategoryId": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z"}

Was this page helpful?