Skip to main content
PATCH
Update form settings and questions
You’re viewing API version 2026-09, which is deprecated and stops working on October 1, 2027. To see the current version, select 2026-10 in the menu at the top of the sidebar. To move your integration, see Upgrading to 2026-10.

Authorizations

Authorization
string
header
required

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

Headers

authorization
string
required

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.

Maximum string length: 255

Path Parameters

id
string
required

Body

application/json

Body

title
string | null
Maximum string length: 200
description
string | null
Maximum string length: 4000
thankYouMessage
string | null
Maximum string length: 4000
redirectUrl
string<uri> | null
Maximum string length: 2000
password
string | null

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

Required string length: 4 - 100
questions
object[]
Maximum array length: 60
expiresAt
string<date-time> | null
Pattern: ^(?:(?:\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)))$
maxSubmissions
integer | null
Required range: 1 <= x <= 100000
documentExpiresInDays
integer
Required range: 1 <= x <= 3650

Response

200

id
string
required
templateId
string
required
workspaceId
string
required
senderUserId
string
required
respondentSignerId
string | null
required
url
string
required
enabled
boolean
required
closedReason
enum<string> | null
required
Available options:
INCOMPLETE,
MAX_SUBMISSIONS,
EXPIRED,
SENDER_LEFT
hasPassword
boolean
required
title
string | null
required
description
string | null
required
thankYouMessage
string | null
required
redirectUrl
string | null
required
documentExpiresInDays
number
required
expiresAt
string | null
required
maxSubmissions
number | null
required
submissionCount
number
required
createdAt
string
required
updatedAt
string
required
questions
object[]
required
Maximum array length: 60
slots
object[]
required
publishIssues
object[]
required
statistics
object
required