API Reference

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

The comment sent by the customer.

date-time | null

When the survey was created.

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.

integer | null
1 to 5

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

date-time | null

When the survey was filled by the customer.

date-time | null

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

date-time | null

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

integer
required

The ID of the ticket the survey is associated with.

Response

Updated 4 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago