Skip to main content
POST
Resume a survey

Authorizations

Authorization
string
header
required

An API key (utk_live_...) or an app's OAuth access token (uto_...).

Headers

Idempotency-Key
string

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.

Maximum string length: 255

Path Parameters

surveyId
string<uuid>
required

A survey id.

Response

The survey.

id
string<uuid>
required
name
string
required
status
enum<string>
required
Available options:
draft,
active,
paused,
archived
channel
enum<string>
required
Available options:
website,
link,
email
site
object | null
required
counts
object | null
required

Responses the plan shows, from its retention window; null when they could not be read.

url
string<uri>
required

The survey in the dashboard.

createdAt
string<date-time>
required
Example:

"2026-09-30T10:00:00.000Z"

updatedAt
string<date-time>
required
Example:

"2026-09-30T10:00:00.000Z"