Collect Feedback Data

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

cfm-public:write

Body Request - Example

{
  "interaction_id": "e4742002f9dc421d92c0395ad9888364",
  "survey_channel": "CHAT",
  "survey_name": "test-flow",
  "question": "On a scale of 1 (least satisfied) to 5 (most satisfied) please rate your overall experience. To opt-out, please reply STOP.",
  "answer": "4",
  "question_type": "CSAT",
  "is_kpi": true
}

Body Response - Schema

400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (internal server error)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!