curl --request POST \
--url https://app.usertick.com/api/public/v1/surveys/{surveyId}/pause \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.usertick.com/api/public/v1/surveys/{surveyId}/pause', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.usertick.com/api/public/v1/surveys/{surveyId}/pause"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"channel": "website",
"site": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>"
},
"counts": {
"responses": 123,
"last7Days": 123,
"lastResponseAt": "2026-09-30T10:00:00.000Z"
},
"url": "<string>",
"createdAt": "2026-09-30T10:00:00.000Z",
"updatedAt": "2026-09-30T10:00:00.000Z"
}Pause a survey
Stops showing a published survey and taking its answers until it is resumed. Recorded in the audit log as made through the credential.
Scopes: surveys:write.
curl --request POST \
--url https://app.usertick.com/api/public/v1/surveys/{surveyId}/pause \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.usertick.com/api/public/v1/surveys/{surveyId}/pause', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.usertick.com/api/public/v1/surveys/{surveyId}/pause"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"channel": "website",
"site": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>"
},
"counts": {
"responses": 123,
"last7Days": 123,
"lastResponseAt": "2026-09-30T10:00:00.000Z"
},
"url": "<string>",
"createdAt": "2026-09-30T10:00:00.000Z",
"updatedAt": "2026-09-30T10:00:00.000Z"
}Authorizations
An API key (utk_live_...) or an app's OAuth access token (uto_...).
Headers
Any 1 to 255 printable ASCII characters, without a space at either end. The answer to the first request with a key is kept for 24 hours per credential: the same request again gets it back (Idempotent-Replayed: true), another request with the key is 409 PUB-002-002, and while the first still runs 409 PUB-002-003. A server error is not kept, and a request that never answered frees its key after 2 minutes: a retry with the key then runs again.
255Path Parameters
A survey id.
Response
The survey.
draft, active, paused, archived website, link, email Show child attributes
Show child attributes
Responses the plan shows, from its retention window; null when they could not be read.
Show child attributes
Show child attributes
The survey in the dashboard.
"2026-09-30T10:00:00.000Z"
"2026-09-30T10:00:00.000Z"