v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Request Form Response

This API endpoint sends a form to client(s) for them to complete.

post/v1/form-responses

Request body

formIdstring required

The ID of the Form to send to the recipient.

clientIdsstring[]

Deprecated. Use clientCompanyIds

Response

200

allowMultipleSubmissionsboolean

clientIdstring

createdAtstring

formDescriptionstring

formFieldIdsstring[]

formIdstring

formNamestring

idstring

objectstring

statusstring

visibilitystring

companyIdstring

updatedAtstring

Example response

{
  "clientId": "55cac2c4-f3a8-4789-a1ea-b4a6f7156a8e",
  "createdAt": "2024-02-12T23:55:07.63927794Z",
  "formFieldIds": [
    "47741982-6b81-4041-8063-d8f825259318"
  ],
  "formFields": {
    "09c8dc93-4532-4995-831e-4bdf1c2e437b": {
      "title": "Select your color scheme:",
      "description": "Color scheme description",
      "type": "multiSelect",
      "multipleChoiceOptions": [
        "Red"
      ]
    },
    "2b7e3a5a-f335-430a-a8e9-8259c9f971d1": {
      "title": "Which industry are you in?",
      "description": "Industry description",
      "type": "singleSelect",
      "multipleChoiceOptions": [
        "Fashion"
      ]
    },
    "425fa7b8-4446-4864-8542-d9a1bdd61991": {
      "title": "Assets Section",
      "description": "Describe and upload your brand assets.",
      "type": "title"
    },
    "47741982-6b81-4041-8063-d8f825259318": {
      "title": "What is your name?",
      "description": "Full name",
      "type": "shortAnswer"
    },
    "7399360f-39f3-415f-af53-e223476b58eb": {
      "title": "Upload your logo(s) here:",
      "description": "File upload description",
      "type": "fileUpload"
    },
    "a9da9a50-4196-4bc6-b6a3-345f33add0ef": {
      "title": "Describe your brand",
      "description": "Brand description",
      "type": "longAnswer"
    }
  },
  "formId": "28e7db81-35b0-4284-96f3-ae097dfdbdd2",
  "formName": "Sample Form All Question Types",
  "id": "son4fbhIg",
  "object": "formResponse",
  "status": "pending",
  "visibility": "requestedClients",
  "companyId": "28e7db81-35b0-4284-96f3-ae097dfdbdd2"
}