Create a survey

post

https://{domain}.gorgias.com/api/satisfaction-surveys

Create a new satisfaction survey. If you don't want the satisfaction survey to be sent by Gorgias set should_send_datetime parameter to null.

Body Params

body_text

string | null

The comment sent by the customer.

created_datetime

date-time | null

When the survey was created.

customer_id

integer

required

The ID of the customer who filled the survey.

meta

object | null

Data associated with the satisfaction survey. You can use this parameter to store structured information (key-value data) about the satisfaction survey. This field is not used by Gorgias.

score

integer | null

1 to 5

The level of satisfaction. Scores range from 1 to 5.

scored_datetime

date-time | null

When the survey was filled by the customer.

sent_datetime

date-time | null

When the survey was sent. If is not set it means that it was not sent yet.

should_send_datetime

date-time | null

When the survey should be sent. If not set then the survey will not be sent by Gorgias.

ticket_id

integer

required

The ID of the ticket the survey is associated with.

Response

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created satisfaction survey.