Skip to content

Create Survey

POST
/feedback/surveys

Create an NPS or CSAT survey.

type fixes the scale (NPS 0-10, CSAT 1-5 unless you override scale_min / scale_max). delivery_channel chooses email, the messaging bridge, or the in-app widget. comment_mode controls whether a respondent can add free text: none, link (score click opens a form) or html (textarea inside the email).

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
comment_mode
Any of:
string
/^(none|link|html)$/
delivery_channel
string
default: email /^(email|bridge|in_app)$/
name
required
string
>= 1 characters <= 255 characters
question_text
required
string
>= 1 characters
scale_max
Any of:
integer
scale_min
Any of:
integer
template_id
Any of:
integer
thank_you_copy
Any of:
string
type
required
string
/^(nps|csat)$/

Responses

201

Successful Response

object
data
required
object
comment_mode
Any of:
string
created_at
Any of:
string format: date-time
delivery_channel
required
string
id
required
string
is_active
required
boolean
name
required
string
question_text
required
string
scale_max
required
integer
scale_min
required
integer
score_field_column_id
Any of:
string
template_id
Any of:
integer
thank_you_copy
Any of:
string
type
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string