Answers

Update answer by ID

Update an answer by ID.

One of choice, choices, or comment is required.

Required scopes: write answers

put/api/v1/answers/{answer_id}

Request

  • Base URL: https://api.simplesat.io
  • URL: https://api.simplesat.io/api/v1/answers/{answer_id}
  • Auth: API key in header X-Simplesat-Token

Path parameters

answer_idstring required

The ID of the answer to update

Request body

choicestring
choicesstring[]
commentstring nullable
follow_up_answerstring nullable
follow_up_answer_choicestring nullable
follow_up_answer_choicesstring[]

Example request

{
  "choice": "4"
}

Response

Successful response

idinteger
choicestring
choice_labelstring
choicesstring[]
commentstring nullable
follow_up_answerstring nullable
follow_up_answer_choicestring nullable
follow_up_answer_choicesstring[]
published_as_testimonialboolean
createdstring date-time
modifiedstring date-time
sentimentstring
response_idinteger

Example response

{
  "id": 1,
  "choice": "2",
  "choice_label": "Bad, I'm unsatisfied",
  "choices": null,
  "comment": null,
  "follow_up_answer": "Very slow!",
  "follow_up_answer_choice": "yes",
  "follow_up_answer_choices": null,
  "published_as_testimonial": false,
  "created": "2024-01-01T00:00:000000Z",
  "modified": "2024-01-01T00:00:000000Z",
  "question": {
    "id": 1,
    "text": "How did we do?",
    "metric": "csat"
  },
  "sentiment": "negative",
  "survey": {
    "id": 1,
    "name": "Generic"
  },
  "response_id": 1,
  "topics": [
    {
      "id": 1,
      "name": "Response time",
      "description": "How quickly the team responded to the request.",
      "sentiment": "positive"
    }
  ]
}

Changes

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