Save the complete form draft

Atomically saves the builder-compatible schema and, when supplied, the complete form settings snapshot. Reuse the same mutation_id only when retrying the exact same request body.

put/forms/{form_id}/draft

Request

  • Base URL: https://app.formasty.com/api/v1
  • URL: https://app.formasty.com/api/v1/forms/{form_id}/draft
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.formasty.com/oauth/authorize/api/v1, token URL https://app.formasty.com/oauth/token)
    • HTTP bearer

Path parameters

form_idstring required

Request body

settingsobject

Optional complete form settings snapshot. When supplied, schema and settings commit as one draft revision.

draft_revisioninteger required
mutation_idstring

Client-generated idempotency key for this logical save. Reuse it only for byte-for-byte equivalent retries.

Response

Saved draft, or the stored result of an exact mutation_id retry.

settingsobject required

Complete operational settings for the current draft. Send this snapshot with draft_schema when changing both.

draft_revisioninteger
public_urlstring

Changes

No recorded changes to this operation across all 1 revision of this API.