Skip to main content
PATCH
Rename or archive a survey
The Dialer is a newly released product surface: depending on your account’s rollout stage, campaigns managed through this API may not yet be visible in your CloudTalk Dashboard.

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Path Parameters

surveyId
string
required

Survey ID (BIGINT serialized as string in responses; send the numeric value).

Pattern: ^[1-9][0-9]*$

Body

application/json

Body of the patch-survey call. Only these two fields are patchable — questions change through the replace-questions call.

name
string

New display name.

Required string length: 1 - 255
Example:

"Post-call qualification v2"

is_archived
boolean

true archives the survey (its soft delete), false restores it.

Example:

true

Response

The updated survey definition.

A survey with its full ordered question set. Returned by every single-survey call; the list serves summaries instead.

id
string

Survey ID.

Example:

"8"

name
string

Display name.

Maximum string length: 255
Example:

"Post-call qualification"

is_archived
boolean

Whether the survey is archived (soft-deleted). Archiving preserves collected answers.

Example:

false

questions
object[]

The survey's questions, ordered by display_order.

created_at
string<date-time>

When the survey was created (ISO 8601, UTC).

Example:

"2026-07-01T09:00:00.000Z"

updated_at
string<date-time>

When the survey last changed (ISO 8601, UTC).

Example:

"2026-08-04T11:40:00.000Z"