Skip to main content
POST
Create a survey

Authorizations

Authorization
string
header
required

A Contact Button scoped bearer key. Send Authorization: Bearer <token>. Token abilities are enforced independently of workspace membership; both checks must pass. OAuth 2.0 authorization-code flows are not currently available.

Headers

Idempotency-Key
string

Stable 8–120 character key for safe mutation retries.

Required string length: 8 - 120

Path Parameters

workspace
string<uuid>
required

Body

application/json
name
string
required
Maximum string length: 255
questions
object[]
required
Required array length: 1 - 100 elements
slug
string
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
description
string
Maximum string length: 2000
status
enum<string>
Available options:
draft,
published,
paused,
archived
settings
object
design
object
distribution
object

Response

Successful data envelope.

data
any
required
meta
object
required