---
title: "Create a survey"
method: POST
path: "/surveys"
tags: ["Surveys"]
---

# Create a survey

`POST /surveys`

## 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`
- Auth: HTTP bearer

Author a new conversational survey from a question set.

## Request body

- object
  - `name` string, required
  - `description` string
  - `definition` object, required: SurveyDefinition: { intro?, outro?, questions: [{ questionId, prompt, type, options?, minRating?, maxRating?, required? }] }.
  - `startDate` string: ISO date; schedules the survey.
  - `endDate` string
  - `timezone` string
  - `languageCode` string[]
  - `isPreferencesSurvey` boolean
  - `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)