Skip to content

Create Survey Trigger

POST
/feedback/surveys/{survey_id}/triggers

Bind an automated send to this survey.

scheduled needs audience_ref + cadence_days; list_entry needs audience_ref; stage_entry needs stage_value. An audience_ref that does not exist in this org is refused rather than silently never firing.

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

Configure an automated-send binding (Phase 3, RFC §5).

  • scheduled : requires audience_ref + cadence_days (30/60/90).
  • list_entry : requires audience_ref (the watch list).
  • stage_entry: requires stage_value (the to_stage slug).
object
audience_ref
Any of:
string
cadence_days
Any of:
integer
>= 1 <= 3650
reply_to
Any of:
string format: email
sender_email
required
string format: email
sender_name
Any of:
string
stage_value
Any of:
string
subject
required
string
>= 1 characters <= 2000 characters
trigger_kind
required
string
/^(scheduled|list_entry|stage_entry)$/

Responses

201

Successful Response

object
data
required
object
audience_ref
Any of:
string
cadence_days
Any of:
integer
id
required
string
is_active
required
boolean
reply_to
Any of:
string
sender_email
required
string
sender_name
Any of:
string
stage_value
Any of:
string
subject
required
string
survey_id
required
string
trigger_kind
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