Skip to Content

Update form settings and questions

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/forms/{id}

Omitted settings stay unchanged; nullable values can be cleared explicitly. Questions replace the complete ordered question list. Saving never publishes or changes the sender. Requires forms:write and documents:write, including for drafts. An edit introducing a blocker closes a published form until it is fixed and republished.

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
title?|
Lengthlength <= 200
description?|
Lengthlength <= 4000
thankYouMessage?|
Lengthlength <= 4000
redirectUrl?|
Formaturi
Lengthlength <= 2000
password?|

Omit to keep the password, null to remove it, or a string to replace it.

Length4 <= length <= 100
questions?array<||||||>
Itemsitems <= 60
expiresAt?|
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
maxSubmissions?|
Range1 <= value <= 100000
documentExpiresInDays?integer
Range1 <= value <= 3650

Response Body

200

application/json
  1. response
id*string
templateId*string
workspaceId*string
senderUserId*string
respondentSignerId*string|null
url*string
enabled*boolean
closedReason*|
Value in"INCOMPLETE""MAX_SUBMISSIONS""EXPIRED""SENDER_LEFT"
hasPassword*boolean
title*string|null
description*string|null
thankYouMessage*string|null
redirectUrl*string|null
documentExpiresInDays*number
expiresAt*string|null
maxSubmissions*number|null
submissionCount*number
createdAt*string
updatedAt*string
questions*array<||||||>
Itemsitems <= 60
slots*array<>
publishIssues*array<>
statistics*
Example Request
curl -X PATCH 'https://app.sajn.se/api/v1/forms/string' \  -H 'authorization: string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "templateId": "string",  "workspaceId": "string",  "senderUserId": "string",  "respondentSignerId": "string",  "url": "string",  "enabled": true,  "closedReason": "INCOMPLETE",  "hasPassword": true,  "title": "string",  "description": "string",  "thankYouMessage": "string",  "redirectUrl": "string",  "documentExpiresInDays": 0,  "expiresAt": "string",  "maxSubmissions": 0,  "submissionCount": 0,  "createdAt": "string",  "updatedAt": "string",  "questions": [    {      "id": "string",      "label": "string",      "placeholder": "string",      "description": "string",      "width": "full",      "required": true,      "kind": "name"    }  ],  "slots": [    {      "key": "string",      "label": "string",      "type": "string",      "required": true,      "options": [        "string"      ]    }  ],  "publishIssues": [    {      "code": "string",      "severity": "blocker",      "message": "string"    }  ],  "statistics": {    "started": 0,    "signed": 0  }}

Was this page helpful?