Create Response

Create a response for a survey and it’s fields with the user’s responses. The userId & meta here is optional

POST /api/v1/client/{environmentId}/responses

Try it

Create Response

cURL

curl --request POST \
  --url https://{baseurl}/api/v1/client/{environmentId}/responses \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "hs8yd14l9h8u353tjmv6rzaw": "clicked",
    "tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
  },
  "finished": false,
  "meta": {
    "action": "test action",
    "source": "Postman API",
    "url": "https://postman.com"
  },
  "surveyId": "{{surveyId}}",
  "userId": "{{userId}}"
}
'

200

{
  "data": {
    "id": "clvc3aool000p494jzjuukfzu"
  }
}

Path Parameters

environmentId · string · required

Body

application/json

surveyId · string · required

data · object

finished · boolean

language · enum<string>

Language of the response (survey should have this language enabled)

Available options: en, de, pt, etc..

meta · object

Show child attributes

meta. action · string

meta. source · string

meta. url · string

userId · string

Response

200

application/json

OK

The response is of type object.