Bloss Docs

Replace a form's draft

Developers
PATCH
/brands/{brandId}/onboarding/forms/{formId}

Save a form's draft definition, as the form builder does. It replaces the whole draft: send every section and question, keeping the ids of questions you keep (answers are stored under them). Creators see it when the flow is published. The draft's revision as you last read it. If anyone has saved the draft since, nothing is saved and the call answers 409 conflict with details.currentRevision: read it again, reapply your change, and retry. Returns the new revision and what still blocks publishing the form.

Authorization

bearerAuth onboarding:write
headerAuthorizationBearer <token>

Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, onboarding:read, onboarding:signatures, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read, groups:write, videos:write, onboarding:write, sync:write, payouts:write.

Scope: onboarding:write

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length
formId*string

A form id from GET .../onboarding/flows/{flowId} (forms, or a form task's formId).

Length1 <= length

Request Body

application/json
  1. body
revision*integer

The draft's revision as you last read it. If anyone has saved the draft since, nothing is saved and the call answers 409 conflict with details.currentRevision: read it again, reapply your change, and retry.

Range0 <= value <= 9007199254740991
definition*

A form: sections of questions. Ids are yours to choose (any 1–64 characters); a discord field asks the creator to connect Discord (one per form). A question can only depend on one above it.

Response Body

Success.

application/json
  1. response
id*string
revision*number

The draft's new revision.

problems*array<string>

What blocks publishing the form. Empty when it's ready.

curl -X PATCH 'https://example.com/api/v1/brands/string/onboarding/forms/string' \  -H 'Content-Type: application/json' \  -d '{  "revision": 0,  "definition": {    "sections": [      {        "id": "string",        "fields": [          {            "id": "string",            "type": "short_text",            "label": "string"          }        ]      }    ]  }}'
{  "id": "string",  "revision": 0,  "problems": [    "string"  ]}

Was this page helpful?

Get a form's draft and versions GET

One onboarding form: its draft definition (sections and questions) with its revision, the live version creators fill in, its published versions, and what blocks publishing it. Read this before changing the form.

Restore a form version into its draft POST

Copy a published version of a form back into its draft (a new draft revision). Creators see it when the flow is published. Returns the form.