Skip to main content
POST
Submit a form response

Authorizations

Authorization
string
header
required

Company secret API key.

Path Parameters

id
string<ObjectId>
required

Form id

Body

application/json
anonymous
boolean
required

Whether this response is anonymous

Example:

false

answers
object
required

Answers keyed by field id

Example:
email
string

Email of the respondent (required when the form identifies clients by email and the response is not anonymous)

Example:

"respondent@example.com"

phone
string

Phone of the respondent (required when the form identifies clients by phone and the response is not anonymous)

Example:

"+56912345678"

responseChannel
string

Inbound response channel. Defaults to 'api'; a value provided here REPLACES 'api' (user-defined channel). Stored on the response.

Maximum string length: 48
Example:

"my-crm"

dispatchToken
string

Opaque invitation dispatch token echoed from the link (?dtoken=). Consumed to mark the outbound invitation responded; never persisted.

Maximum string length: 64
Example:

"a1b2c3d4-..."

Response

Form response created