manage_suppressions
Manage the suppression list to block specific email addresses or domain patterns from receiving surveys.
Supports listing, adding, and removing suppressed emails and domain patterns. Domain patterns support wildcards (e.g., `*.example.com`) and categorization (corporate, disposable, invalid).
Only manually added suppressions can be removed.
unsubscribe_customers
Unsubscribe one or more customers from receiving future surveys. Optionally include a custom opt-out message explaining the reason for unsubscription.
annotate_feedback
Add topics and/or tags to a survey response. Topics include a sentiment (positive, neutral, or negative).
You can choose to append new topics/tags to existing ones or replace them entirely.
manage_customers
Create, update, or delete customers in Retently. Customers are identified by email address.
When creating or updating, existing customers matched by email will have their data merged (existing properties not included in the request are preserved).
Supports bulk operations for up to 1,000 customers per request.
get_customers
Retrieve customers from Retently. Look up a single customer by ID or email, or list customers with pagination, date range filtering, and custom attribute filters.
get_campaigns
Retrieve all survey campaigns and optionally all survey templates. Each campaign includes its metric type (NPS, CSAT, CES, 5-Star), channel (email, link, in-app, Intercom), campaign type (transactional, recurring), and active status.
Use this to find campaign IDs for sending surveys or filtering feedback.
get_reports
Retrieve campaign reports with trend data, delivery statistics, and additional rating question stats.
Reports can be filtered by a specific campaign and date range. Includes daily trend breakdown, overall scores, and delivery metrics (sent, opened, responded, bounced, opted-out).
get_feedback
Retrieve survey responses and feedback from Retently. Look up a single response by ID, or list responses with filtering by customer, campaign, date range, and custom attributes.
Each response includes score, text feedback, sentiment, topics, tags, and additional question answers.
get_trends
Retrieve trend groups and detailed trend data. Without a groupId, returns all trend groups. With a groupId, returns detailed trend data including current vs baseline scores, trend lines, and respondent distributions.
Supports various date range presets (today, past-week, past-month, etc.) or custom date ranges.
get_score
Retrieve the latest overall score for a specific survey metric (NPS, CSAT, CES, or 5-Star) across your account.
Includes the score value, rating distribution, and respondent category breakdowns (e.g., promoters/passives/detractors for NPS).
get_outbox
Retrieve sent surveys from the outbox with delivery status and recipient details. Filter by campaign, channel, date range, send method, and customer attributes.
Each entry includes delivery status (sent, opened, responded, bounced, opted-out) and response details if available.
send_survey
Send a transactional survey (NPS, CSAT, CES, or 5-Star) to one or more customers via a specified campaign.
The campaign must be a transactional campaign and must be active. Optionally delay sending by a specified number of days.
Recipients that don't exist will be automatically created as customers.
get_companies
Retrieve company information from Retently. Look up a single company by ID or domain name, or list companies with pagination and sorting.
Company data includes industry, tags, NPS/CSAT/CES/Star metrics, and customer counts.