API referenceV1
Open a response (optionally with answers, optionally completing it)
AuthorizationBearer <token>
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
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Default
{}Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/forms/string/responses" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "object": "response", "form_id": "string", "status": "in_progress", "source": "chat", "mode": "live", "started_at": 0, "updated_at": 0, "completed_at": 0, "expires_at": 0, "duration_ms": 0, "ending_ref": "string", "abandon_reason": "string", "metadata": { "channel": "link", "pageUrl": "string", "referrer": "string", "referrerHost": "string", "utm": { "property1": "string", "property2": "string" }, "language": "string", "screen": "string", "timezone": "string", "device": { "type": "mobile", "browser": "string", "browserVersion": "string", "os": "string", "osVersion": "string" }, "geo": { "country": "string", "region": "string", "regionCode": "string", "city": "string", "postalCode": "string", "latitude": 0, "longitude": 0, "continent": "string", "timezone": "string" }, "network": { "asn": 0, "organization": "string" } }, "progress": { "answered": 0, "totalEstimate": 0, "pct": 0 }, "variables": { "property1": null, "property2": null }, "hidden_fields": { "property1": null, "property2": null }, "next": { "kind": "block", "block": { "id": "string", "ref": "string", "type": "string", "title": "string", "required": true, "imageKey": "string", "media": null, "property1": null, "property2": null } }, "complete_ready": true, "missing_required": [ { "ref": "string", "title": "string" } ], "off_path_answers": [ "string" ], "answers": [ { "ref": "string", "type": "string", "value": null } ], "recorded": [ { "ref": "string", "value": null } ], "property1": null, "property2": null}