---
title: "Patch a survey"
method: PATCH
path: "/surveys/{id}"
tags: ["Surveys"]
---

# Patch a survey

`PATCH /surveys/{id}`

## Request

- Base URL: `https://rcs-templates-api-dot-msg2ai-server.ue.r.appspot.com/api/agent`
- URL: `https://rcs-templates-api-dot-msg2ai-server.ue.r.appspot.com/api/agent/surveys/{id}`
- Auth: HTTP bearer

Patch a survey's questions, branching, or metadata.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `description` string
  - `definition` object
  - `status` 'DRAFT' | 'SCHEDULED' | 'ACTIVE' | 'CLOSED'
  - `startDate` string
  - `endDate` string
  - `audienceIds` string[]
  - `channel` 'RCS' | 'WHATSAPP': Channel to act on (RCS or WHATSAPP). Defaults to your org's own brand channel; any other channel requires the matching add-on brand.

## Response `200`

Success.

- object

## Other responses

- `400`: Arguments failed validation.
- `401`: Missing or invalid agent key.
- `403`: Key does not hold the surveys:write scope.
- `429`: Rate limited.

---

[API](https://skmtc.dev/wa-campaigns/apis/whatsapp-campaigns-agent-gateway.md) · [All operations](https://skmtc.dev/wa-campaigns/apis/whatsapp-campaigns-agent-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/wa-campaigns/apis/whatsapp-campaigns-agent-gateway/revisions/24503d56cc7b?raw)