Skip to main content
PATCH
/
api
/
v1
/
documents
/
{id}
Update a document
curl --request PATCH \
  --url https://app.sajn.se/api/v1/documents/{id} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "name": "<string>",
  "externalId": "<string>",
  "expiresAt": "<any>",
  "documentMeta": {
    "subject": "<string>",
    "message": "<string>",
    "signingOrder": "PARALLEL",
    "defaultSignatureType": "DRAWING",
    "distributionMethod": "EMAIL",
    "forceReadFullDocument": true,
    "showCommentsToSigners": true,
    "preferredLanguage": "sv",
    "validFrom": "<any>",
    "validTo": "<any>",
    "value": "<string>"
  },
  "customFields": [
    {
      "customInputId": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "id": "<string>",
  "externalId": "<string>",
  "expiresAt": "<any>",
  "name": "<string>",
  "status": "<string>",
  "documentMeta": {
    "subject": "<string>",
    "message": "<string>",
    "signingOrder": "PARALLEL",
    "defaultSignatureType": "DRAWING",
    "distributionMethod": "EMAIL",
    "forceReadFullDocument": true,
    "showCommentsToSigners": true,
    "preferredLanguage": "sv",
    "validFrom": "<any>",
    "validTo": "<any>",
    "value": "<string>"
  },
  "createdAt": "<any>",
  "updatedAt": "<any>",
  "completedAt": "<any>"
}

Headers

authorization
string
required

Bearer token for API authentication

Path Parameters

id
string
required

Body

application/json

Body

name
string
externalId
string
expiresAt
any
documentMeta
object
customFields
object[]

Response

200

id
string
required

Unique document identifier

name
string
required

Document name/title

status
string
required

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

createdAt
any
required

Date and time when the document was created

updatedAt
any
required

Date and time when the document was last updated

externalId
string | null

Your external reference ID for this document

expiresAt
any

Date and time when the document expires

documentMeta
object | null

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

completedAt
any

Date and time when all signers completed signing

I