Surveys tools
Create hosted surveys, send personal links in sequences and read responses. Survey submissions can trigger or stop a sequence.
upsert_survey
Create or fully replace a survey by key. Use {{survey.key}} in sequence email or SMS templates for a personal link. Broadcast survey links are unavailable. Past responses retain their question snapshots. A survey link is about 150 characters, so it adds an SMS segment. Optional logo_url (https) shows the brand logo at the top of the survey page; omitting it clears it.
keystringrequirednamestringrequiredintrostringdefault ""logo_urlstring | nullthank_youstringdefault "Thank you for your feedback."questionsobject[]requiredquestions[].keystringrequiredquestions[].labelstringrequiredquestions[].requiredbooleanrequiredquestions[].typeliteralrequired- rating | nps | text | choice
questions[].optionsstring[]required when type is choiceteamstringrequired- Brand/team to act on (slug or id) → X-Cadence-Team. Required — your account key authorizes every brand you own, so this picks which one.
list_surveys
List live surveys for the team.
teamstringrequired- Brand/team to act on (slug or id) → X-Cadence-Team. Required — your account key authorizes every brand you own, so this picks which one.
delete_survey
Close a survey. Refused while a template references it unless confirm is true. Old links stay closed even if the key is reused.
keystringrequiredconfirmbooleanteamstringrequired- Brand/team to act on (slug or id) → X-Cadence-Team. Required — your account key authorizes every brand you own, so this picks which one.
list_survey_responses
List survey responses newest first, including the original questions and answers. Pass next_cursor to load older responses.
keystringrequiredcursorstringlimitnumberteamstringrequired- Brand/team to act on (slug or id) → X-Cadence-Team. Required — your account key authorizes every brand you own, so this picks which one.