curl --request PATCH \
--url https://api.cloudtalk.io/v1/dialer/surveys/{surveyId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"is_archived": true
}
'import requests
url = "https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}"
payload = { "is_archived": True }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({is_archived: true})
};
fetch('https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'is_archived' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}"
payload := strings.NewReader("{\n \"is_archived\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"is_archived\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_archived\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "8",
"name": "Post-call qualification",
"is_archived": false,
"questions": [
{
"id": "310",
"label": "Was the customer interested?",
"type": "radio",
"is_required": true,
"display_order": 0,
"options": [
{
"id": "901",
"label": "Yes",
"display_order": 0
},
{
"id": "902",
"label": "No",
"display_order": 1
}
]
}
],
"created_at": "2026-07-01T09:00:00.000Z",
"updated_at": "2026-08-04T11:40:00.000Z"
}{
"statusCode": 400,
"message": "Validation error",
"error": "Bad Request",
"correlationId": "YevPQs",
"subErrors": [
"incorrect email"
]
}{
"code": "UNAUTHORIZED",
"message": "You are not authorized to access this resource."
}{
"statusCode": 404,
"message": "Not Found",
"error": "Not Found",
"correlationId": "YevPQs"
}{
"statusCode": 429,
"message": "Too Many Requests",
"error": "Too Many Requests",
"correlationId": "YevPQs"
}{
"statusCode": 500,
"message": "Internal Server Error",
"error": "Internal Server Error",
"correlationId": "YevPQs"
}Rename or archive a survey
Updates the survey’s name and/or is_archived flag — nothing else is patchable here; questions change only through the replace-questions call. Archiving (is_archived: true) is the survey’s soft delete: there is deliberately no DELETE route, because archiving preserves the answers already collected — a DELETE on this path is an unmatched route and answers 404 Route not found. Restore with is_archived: false.
curl --request PATCH \
--url https://api.cloudtalk.io/v1/dialer/surveys/{surveyId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"is_archived": true
}
'import requests
url = "https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}"
payload = { "is_archived": True }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({is_archived: true})
};
fetch('https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'is_archived' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}"
payload := strings.NewReader("{\n \"is_archived\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"is_archived\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudtalk.io/v1/dialer/surveys/{surveyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_archived\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "8",
"name": "Post-call qualification",
"is_archived": false,
"questions": [
{
"id": "310",
"label": "Was the customer interested?",
"type": "radio",
"is_required": true,
"display_order": 0,
"options": [
{
"id": "901",
"label": "Yes",
"display_order": 0
},
{
"id": "902",
"label": "No",
"display_order": 1
}
]
}
],
"created_at": "2026-07-01T09:00:00.000Z",
"updated_at": "2026-08-04T11:40:00.000Z"
}{
"statusCode": 400,
"message": "Validation error",
"error": "Bad Request",
"correlationId": "YevPQs",
"subErrors": [
"incorrect email"
]
}{
"code": "UNAUTHORIZED",
"message": "You are not authorized to access this resource."
}{
"statusCode": 404,
"message": "Not Found",
"error": "Not Found",
"correlationId": "YevPQs"
}{
"statusCode": 429,
"message": "Too Many Requests",
"error": "Too Many Requests",
"correlationId": "YevPQs"
}{
"statusCode": 500,
"message": "Internal Server Error",
"error": "Internal Server Error",
"correlationId": "YevPQs"
}Authorizations
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
Survey ID (BIGINT serialized as string in responses; send the numeric value).
^[1-9][0-9]*$Body
Body of the patch-survey call. Only these two fields are patchable — questions change through the replace-questions call.
New display name. Leading and trailing whitespace is trimmed before validation, so a blank or whitespace-only name is rejected with 400 (name should not be empty in subErrors).
1 - 255\S"Post-call qualification v2"
true archives the survey (its soft delete), false restores it.
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.
Survey ID.
"8"
Display name.
255"Post-call qualification"
Whether the survey is archived (soft-deleted). Archiving preserves collected answers.
false
The survey's questions, ordered by display_order.
Show child attributes
Show child attributes
When the survey was created (ISO 8601, UTC).
"2026-07-01T09:00:00.000Z"
When the survey last changed (ISO 8601, UTC).
"2026-08-04T11:40:00.000Z"