---
title: "Update response by ID"
method: PUT
path: "/api/v1/responses/{response_id}/update"
tags: ["Responses"]
---

# Update response by ID

`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`

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`

## Path parameters

- `response_id` string, required

## Request body

- object
  - `survey_id` integer, required
  - `language` string
  - `created` string, date-time
  - `tags` string[]
  - `answers` object[]
    - `question_id` integer, required
    - `choice` string
    - `choices` string[]
    - `comment` string
    - `sentiment` string
    - `follow_up_answer` string
    - `follow_up_answer_choice` string
    - `follow_up_answer_choices` string[]
  - `team_members` object[]
    - `external_id` string
    - `name` string
    - `email` string, required
    - `custom_attributes` object
    - `role` string
    - `is_primary` boolean
  - `ticket` object
    - `external_id` string
    - `subject` string
    - `custom_attributes` object
  - `customer` object
    - `external_id` string
    - `name` string
    - `email` string, required
    - `tags` string[]
    - `company` string
    - `custom_attributes` object

## Response `200`

Successful response

- object
  - `survey_id` integer
  - `language` string
  - `ticket` object
    - `id` integer
    - `external_id` string
    - `subject` string
    - `custom_attributes` object
  - `team_members` object[]
    - `external_id` string
    - `name` string
    - `email` string
    - `custom_attributes` object
    - `role` string
    - `is_primary` boolean
    - `groups` TeamMemberGroup[]: The team member's groups.
      - `token` string: Unique identifier for the team member group, defined by Simplesat.
      - `name` string: The name of the team member group.
  - `customer` object
    - `external_id` string
    - `name` string
    - `email` string
    - `tags` string[]
    - `company` string
    - `custom_attributes` object
  - `answers` object[]
    - `id` integer
    - `question` object
      - `id` integer
      - `text` string
      - `metric` string
    - `choice` string
    - `choices` string[]
    - `comment` string
    - `sentiment` string
    - `follow_up_answer` string
    - `choice_label` string
    - `follow_up_answer_choice` string
    - `follow_up_answer_choices` string[]
    - `follow_up_question` object
      - `id` integer
      - `text` string
      - `metric` string
    - `topics` Topic[]
      - `id` integer: Unique identifier for the topic, defined by Simplesat.
      - `name` string: The name of the topic.
      - `description` string: A description of the topic.
      - `sentiment` string: The sentiment associated with the topic for this answer.
  - `id` integer
  - `tags` string[]
  - `created` string, date-time
  - `modified` string, date-time
  - `ip_address` string

## Other responses

- `404`: Not found

---

[API](https://skmtc.dev/simplesat/apis/simplesat-api-v1.md) · [All operations](https://skmtc.dev/simplesat/apis/simplesat-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/simplesat/apis/simplesat-api-v1/revisions/1c245425416b?raw)