Unpublish a form
Stop new submissions and return the form. Republishing preserves the URL. Existing documents continue through signing.
Authorizations
Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.
Headers
API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.
2026-09, 2026-10 ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.
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.
255Path Parameters
The form ID.
Response
200
The form ID.
The ID of the template the form owns. Its documents are created from it.
The workspace ID.
The member every document from the form is created and sent as.
The ID of the template party the respondent becomes. Null on a draft without one.
The public form link.
True if the form is published.
Why a published form stopped accepting submissions. Null while it's open.
INCOMPLETE, MAX_SUBMISSIONS, EXPIRED, SENDER_LEFT, null True if the link requires a password.
Name of the form, shown as the heading of the public form page.
Introduction shown under the heading.
Message shown after the respondent submits.
URL the respondent goes to after submitting.
Days each document created from a submission stays signable.
When the form closes to new submissions. Null keeps it open.
Most submissions the form accepts. Null means no limit.
Active starts plus submitted responses, counted against maxSubmissions.
When the form was created.
When the form was last updated.
60- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
The keyed FORM subfields of the form's document that a FIELD question can fill.
What stops the form from publishing (BLOCKER) or deserves a look (WARNING). Empty when the form is ready.

