Skip to main content
POST
Create a survey

Authorizations

Authorization
string
header
required

An API key issued by a company administrator — an environment prefix (production: sdb_live_) followed by 32 characters. The prefix identifies the environment and MUST NOT be hard-coded or validated by clients; treat the whole key as opaque. Shown exactly once at creation; only a one-way hash is stored.

Scopes (granted per key on the create screen; :write never implies :read):

  • skills:read
  • skills:write
  • people:read
  • people:write
  • careers:read
  • careers:write
  • training:read
  • training:write
  • flags:read
  • flags:write
  • org:read
  • org:write
  • assessments:read
  • learning:read
  • learning:write
  • certifications:read
  • certifications:write
  • assessments:write
  • proficiency:read
  • proficiency:write
  • surveys:read
  • surveys:write
  • labels:read
  • labels:write

Headers

Idempotency-Key
string

Any unique string (at most 200 characters). Retrying with the same key and identical content replays the stored response for 24h instead of executing twice.

Maximum string length: 200

Body

application/json
name
string
required
Maximum string length: 255
Example:

"Q3 onboarding pulse"

templateVersionId
string
required

A survey template version of the company. Authoring templates is not part of the API.

Example:

"88"

toAllPeople
boolean

When true the selections below are ignored and everyone is targeted.

Example:

false

businessUnitIds
string[]
divisionIds
string[]
countryIds
string[]
businessRegionIds
string[]
cityIds
string[]
siteIds
string[]
departmentIds
string[]
teamIds
string[]
shiftIds
string[]
people
string[]

People to include by name — emails or ids.

description
string
Maximum string length: 2000
Example:

"Sent to everyone who joined this quarter."

dueDate
string
Example:

"2026-07-31T00:00:00.000Z"

scheduledFor
string

A future launch time; the survey is created as scheduled.

Example:

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

Response

The created resource, enveloped.

data
object
required