Surveys

Send survey by email

Send a survey email.

Only survey tokens of surveys with survey type event_based_email are accepted.

Required scopes: write surveys

post/api/v1/surveys/{survey_token}/email

Request

Base URL: https://api.simplesat.io
URL: https://api.simplesat.io/api/v1/surveys/{survey_token}/email
Auth: API key in header X-Simplesat-Token

Path parameters

survey_tokenstring required

The token of the survey to send

Request body

Example request

{
  "customer": {
    "id": "1",
    "email": "tester@simplesat.io",
    "name": "Tester McTestFace",
    "company": "Simplesat",
    "language": "en",
    "custom_attributes": {
      "Country": "United States",
      "City": "San Francisco"
    }
  },
  "team_member": {
    "id": "1",
    "email": "tester@simplesat.io",
    "name": "Tester McTestFace",
    "custom_attributes": {
      "Department": "Support",
      "Level": "Senior"
    }
  },
  "ticket": {
    "id": "1",
    "subject": "Ticket subject",
    "custom_attributes": {
      "Priority": "Medium",
      "Category": "Support"
    }
  }
}

Response

Successful response

detailstring

Example response

{
  "detail": "Survey is scheduled to be sent"
}

Changes

No recorded changes to this operation across all 1 revision of this API.