Create Satisfaction Survey

Create a survey

POST/api/satisfaction-surveys

Use it in a workflow

Add a step and choose the Gorgias connector.
Pick the Create Satisfaction Survey action (under Satisfaction Surveys).
Fill in the fields below, then reference the result from later steps as {{createSatisfactionSurvey.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

body_textstring | null

The comment sent by the customer.

created_datetimestring | null

When the survey was created.

customer_idintegerrequired

The ID of the customer who filled the survey.

metaobject | 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.

scoreinteger | null

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

scored_datetimestring | null

When the survey was filled by the customer.

sent_datetimestring | null

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

should_send_datetimestring | null

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

ticket_idintegerrequired

The ID of the ticket the survey is associated with.

json

{
  "customer_id": 120,
  "ticket_id": 12,
  "body_text": "Such speed, much pertinent.",
  "created_datetime": "2019-11-16T15:59:41.966927",
  "meta": {
    "externalData": {
      "id": 1234
    }
  },
  "score": 2,
  "scored_datetime": "2019-11-25T15:59:41.966927",
  "sent_datetime": "2019-11-23T15:59:41.966927",
  "should_send_datetime": "2019-11-23T15:59:41.966927"
}

Response

Returns 201 with an object. Read it in later steps with {{createSatisfactionSurvey.response.data.<field>}}.

idinteger

ID of the survey.