Sign in
collect.sessions

Submit form data to a collect session

Submits a form field value for a collect item via a public token.

post/collect/sessions/{token}/submit/form-data

Path parameters

tokenstring required

The session token

Example:cs_live_cmll8jh7b00013b6tlu7lvntw

Request body

collectItemIdstring uuid required

The ID of the collect item to submit against

valuestring required

The form field value

Example request

{
  "collectItemId": "550e8400-e29b-41d4-a716-446655440000",
  "value": "Max Mustermann"
}

Response

Form data submitted successfully

idstring uuid required

The ID of the submission

statusstring required

The status of the submission

valuestring nullable required

The submitted form field value

collectItemIdstring uuid required

The ID of the collect item

createdAtstring date-time required

The date and time the submission was created

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "pending",
  "value": "Max Mustermann",
  "collectItemId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-01T00:00:00.000Z"
}

Changes

Changed in 1 of the 5 revisions of this API.1

  • 80748f72965e1See the full diff
    • ○

      added the media type application/json for the response with the status 500

      response-media-type-added