Skip to content

Send Survey

POST
/feedback/surveys/{survey_id}/send

Send a survey to an audience. Real mail goes to real people.

audience_ref is a list id. For the email channel sender_email must sit on a verified sending domain (GET /surveys/sending-domains) and subject is required. Set scheduled_at to queue it for later. Returns 202 with a send_id — dispatch is asynchronous; poll GET /surveys/sends/{send_id}.

Authorizations

Parameters

Path Parameters

survey_id
required

Survey id (UUID) — from GET /feedback/surveys

string

Survey id (UUID) — from GET /feedback/surveys

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
audience_ref
required
string
>= 1 characters
channel
string
default: email /^(email|bridge)$/
reply_to
Any of:
string format: email
scheduled_at
Any of:
string format: date-time
sender_email
Any of:
string format: email
sender_name
Any of:
string
subject
Any of:
string
<= 2000 characters

Responses

202

Successful Response

object
data
required

A send that has been accepted for dispatch, not yet delivered.

object
recipient_count
required

Contacts resolved from the audience at accept time.

integer
send_id
required

Poll GET /surveys/sends/{send_id} for progress.

integer
status
required

Dispatch state, e.g. queued or scheduled.

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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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