> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Retently

> Retently is a customer experience management platform that enables businesses to collect, analyze, and act on customer feedback through surveys and integrations.

![Retently logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/retently.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=78ceed149e8782377f5fd4a8f41d0cf1)

* **Category:** forms & surveys
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 15
* **Triggers:** 0
* **Slug:** `RETENTLY`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Feedback Tags
>
> **Slug:** `RETENTLY_ADD_FEEDBACK_TAGS`
>
> Add or replace tags on a single feedback response by its ID. By default existing tags are replaced; choose append to retain them.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the feedback response.
>
> **op** `string`
>
> Use the flag “append” in order to append the tags to the response, or leave it empty in order to override existing tags.
>
> **tags** `array` *required*
>
> An array of tags to be added.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Feedback Topics
>
> **Slug:** `RETENTLY_ADD_FEEDBACK_TOPICS`
>
> Add or replace topics on a single feedback response by its ID. By default existing topics are replaced; choose append to retain them.
>
> #### Input Parameters
>
> **topics** `array` *required*
>
> A list of topics to add to the feedback.
>
> **operation** `string ("append" | "override")`
>
> Use 'append' to add to existing topics, or 'override' to replace them.
>
> **feedback\_id** `string` *required*
>
> The ID of the feedback to add topics to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create or Update Customers
>
> **Slug:** `RETENTLY_CREATE_OR_UPDATE_CUSTOMERS`
>
> Tool to create new customers or update existing ones by providing their details, including email, name, company, tags, and properties. Use this to manage your customer base in Retently.
>
> #### Input Parameters
>
> **subscribers** `array` *required*
>
> A list of customer objects to be created or updated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Customers
>
> **Slug:** `RETENTLY_DELETE_CUSTOMERS`
>
> Delete customers from the workspace by providing their email addresses.
>
> #### Input Parameters
>
> **subscribers** `array` *required*
>
> A list of customer objects to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaigns
>
> **Slug:** `RETENTLY_GET_CAMPAIGNS`
>
> Tool to retrieve a list of campaigns associated with the account. Use when you need to get details about all campaigns.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customer By ID
>
> **Slug:** `RETENTLY_GET_CUSTOMER_BY_ID`
>
> Tool to retrieve detailed information about a specific customer by their unique ID. Use when you need to get all the details of a customer.
>
> #### Input Parameters
>
> **customer\_id** `string` *required*
>
> The ID of the customer to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Customers
>
> **Slug:** `RETENTLY_GET_CUSTOMERS`
>
> Retrieve a list of customers with optional parameters for pagination, sorting, and filtering by email or date range.
>
> #### Input Parameters
>
> **page** `integer`
>
> The current page number. Default 1;
>
> **sort** `string`
>
> The sort option. Use ‘-’ for DESC. Default ‘-createdDate’;
>
> **email** `string`
>
> Find a customer by the email address.
>
> **limit** `integer`
>
> The items limit. Default 20;
>
> **endDate** `string`
>
> ISO format or UNIX timestamp;
>
> **startDate** `string`
>
> ISO format or UNIX timestamp;
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Feedback
>
> **Slug:** `RETENTLY_GET_FEEDBACK`
>
> Tool to retrieve feedback received from customers. Use when you need to get a list of feedback, with optional parameters for pagination and sorting.
>
> #### Input Parameters
>
> **page** `integer`
>
> The current page number. Default 1
>
> **sort** `string`
>
> The sort option. Use ‘-’ for DESC. Default ‘-createdDate’
>
> **email** `string`
>
> Search responses by a customer’s email address
>
> **limit** `integer`
>
> The items limit. Default 20
>
> **endDate** `string`
>
> The end date for the feedback, in UNIX timestamp format.
>
> **startDate** `string`
>
> The start date for the feedback, in UNIX timestamp format.
>
> **campaignId** `string`
>
> Filter responses by a specific campaign ID
>
> **customerId** `string`
>
> Search responses by a customer’s Retently ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Feedback by ID
>
> **Slug:** `RETENTLY_GET_FEEDBACK_BY_ID`
>
> Tool to retrieve detailed information about specific feedback by its unique ID. Use when you need to get the details of a single feedback entry.
>
> #### Input Parameters
>
> **feedback\_id** `string` *required*
>
> The unique identifier of the feedback to be retrieved.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Latest Score
>
> **Slug:** `RETENTLY_GET_LATEST_SCORE`
>
> Tool to retrieve the latest NPS score for the account. Use when you need to get the most up-to-date NPS score.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Outbox
>
> **Slug:** `RETENTLY_GET_OUTBOX`
>
> Retrieve a paginated outbox of sent surveys, with optional email filtering and sorting.
>
> #### Input Parameters
>
> **page** `integer`
>
> The current page number.
>
> **sort** `string`
>
> The sort option. Use -surveyCreatedDate for results in descending order.
>
> **email** `string`
>
> Find a customer’s outbox records by email address.
>
> **limit** `integer`
>
> The number of items per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reports
>
> **Slug:** `RETENTLY_GET_REPORTS`
>
> Tool to retrieve reports related to NPS surveys, including scores and trends. Use when you need to get campaign performance data.
>
> #### Input Parameters
>
> **end\_date** `string`
>
> The end date for the report in YYYY-MM-DD format.
>
> **start\_date** `string`
>
> The start date for the report in YYYY-MM-DD format.
>
> **campaign\_id** `string`
>
> The ID of the campaign to get reports for. If not provided, reports for all campaigns will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Templates
>
> **Slug:** `RETENTLY_GET_TEMPLATES`
>
> Tool to retrieve a list of survey templates available in the account. Use when you need to get the available survey templates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Transactional Survey
>
> **Slug:** `RETENTLY_SEND_TRANSACTIONAL_SURVEY`
>
> Tool to send a transactional survey to customers. Use when you need to send a survey to a customer after a specific event, with an optional delay.
>
> #### Input Parameters
>
> **delay** `integer`
>
> The delay in days to send the survey after the triggered event.
>
> **campaign\_id** `string` *required*
>
> The ID of the campaign where the customers will be surveyed.
>
> **subscribers** `array` *required*
>
> A list of customers to send the survey to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unsubscribe Customers
>
> **Slug:** `RETENTLY_UNSUBSCRIBE_CUSTOMERS`
>
> Unsubscribe customers from receiving surveys by providing their email addresses.
>
> #### Input Parameters
>
> **message** `string`
>
> Opt out message.
>
> **subscribers** `array` *required*
>
> An array of subscriber emails.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
