Create a survey invite link

Mints a single-use, per-interaction survey link carrying your context metadata (interaction id, channel, agent, trigger event, arbitrary metadata). Send the returned inviteUrl to your customer over any channel.

The raw link is returned exactly once — it is stored hashed and cannot be recovered later.

Survey-fatigue caps apply per contact (contactId or externalCustomerRef): when the org's cap is hit the call still returns 200 with result: "suppressed" and a nextEligibleAt timestamp, and no link is created. Handle both result shapes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params
string

CRM contact id — enables fatigue caps + roll-ups.

string

Caller's own customer key when no CRM contact exists.

string

Ticket / chat / call id this survey is about.

string
string

ISO instant of the interaction.

string
string

Agent (user) who handled the interaction.

string
string
string
metadata
object

Arbitrary metadata stored verbatim and echoed in webhooks/exports.

number

Overrides the form default TTL.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json