Picture a form's draft
Opens the working draft in a headless browser, as a respondent would first see it, and returns a PNG. Nothing is published. `screen` opens on one question by its ref. Ten a minute per key.
A server-side secret key. Never send one from a browser — a request carrying an Origin header is refused for this reason.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/forms/string/preview" \ -H "Content-Type: application/json" \ -d '{}'{ "preview_url": "string", "expires_at": 0, "device": "phone", "image": { "mime_type": "image/png", "data": "string" }, "note": "string"}Change a form's draft with ops
Applies a batch of ops to the working document: questions, flow, endings, settings, a look, placed pictures and text, background, music, screen sounds, celebrations and branding. Each op lands on its own; one that does not fit comes back in `rejected` with the reason and the rest still land. A setting the plan does not include comes back in `locked`. Asset ids come from the elements library or the organization's uploaded pictures. The draft is saved with the same fixes as `PUT /v1/forms/{id}/doc`; nothing is live until `POST /v1/forms/{id}/publish`.
Publish the working document as a new immutable version
Next Page