Responses

Update response by ID

Update a response by ID.

Updating the tags field, or any of the custom_attributes fields will overwrite any existing values.

Required scopes: write responses

put/api/v1/responses/{response_id}/update

Request

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

Path parameters

response_idstring required

The ID of the response to update

Request body

survey_idinteger required
languagestring
createdstring date-time
tagsstring[]

Example request

{
  "survey_id": 1,
  "created": "2024-01-01T00:00:00Z",
  "answers": [
    {
      "question_id": 1,
      "choice": "4"
    }
  ]
}

Response

Successful response

survey_idinteger
languagestring
idinteger
tagsstring[]
createdstring date-time
modifiedstring date-time
ip_addressstring

Example response

{
  "survey_id": 1,
  "ticket": {
    "id": 1,
    "external_id": "1",
    "subject": null,
    "custom_attributes": {
      "Priority": "Medium",
      "Category": "Support"
    }
  },
  "team_members": [
    {
      "id": 1,
      "external_id": "1",
      "name": "Tester McTestFace",
      "email": "tester@simplesat.io",
      "custom_attributes": {
        "Department": "Support",
        "Level": "Senior"
      },
      "role": "Team member",
      "is_primary": true,
      "groups": [
        {
          "token": "iLA0X65ayqAgnnqnKSFuAwlgtiFGbt3gcN-L73SHNP0",
          "name": "Outsource BPO"
        }
      ]
    }
  ],
  "customer": {
    "id": 1,
    "external_id": "1",
    "name": "Tester McTestFace",
    "email": "tester@simplesat.io",
    "company": "Simplesat",
    "tags": [
      "tag1",
      "tag2"
    ],
    "custom_attributes": {
      "Country": "United States",
      "City": "San Francisco",
      "Channels": [
        "Web",
        "Mobile App"
      ]
    }
  },
  "answers": [
    {
      "id": 1,
      "question": {
        "id": 1,
        "text": "How did we do?",
        "metric": "csat"
      },
      "choice": "4",
      "choices": null,
      "comment": null,
      "sentiment": "positive",
      "follow_up_answer": "Great!",
      "choice_label": "Great, I'm satisfied",
      "follow_up_answer_choice": "yes",
      "follow_up_answer_choices": null,
      "follow_up_question": {
        "id": 1,
        "text": "Was there anything in particular we did that delighted you?",
        "metric": "custom"
      },
      "topics": [
        {
          "id": 1,
          "name": "Response time",
          "description": "How quickly the team responded to the request.",
          "sentiment": "positive"
        }
      ]
    }
  ],
  "id": 1,
  "tags": [],
  "created": "2024-01-01T01:00:00Z",
  "modified": "2024-01-01T01:00:00Z",
  "ip_address": "192.168.1.1",
  "survey": {
    "id": 1,
    "name": "CSAT Survey"
  },
  "language": "en"
}

Changes

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