# Retently

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

- **Category:** forms & surveys
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 15
- **Triggers:** 0
- **Slug:** `RETENTLY`
- **Version:** 20260227_00

## Tools

### Add Feedback Tags

**Slug:** `RETENTLY_ADD_FEEDBACK_TAGS`

Add tags to feedback items by providing feedback IDs and corresponding tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the feedback response. |
| `op` | string | No | 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 | Yes | An array of tags to be added. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Feedback Topics

**Slug:** `RETENTLY_ADD_FEEDBACK_TOPICS`

Add topics to feedback items by providing feedback IDs and corresponding topics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `topics` | array | Yes | A list of topics to add to the feedback. |
| `operation` | string ("append" | "override") | No | Use 'append' to add to existing topics, or 'override' to replace them. |
| `feedback_id` | string | Yes | The ID of the feedback to add topics to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscribers` | array | Yes | A list of customer objects to be created or updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customers

**Slug:** `RETENTLY_DELETE_CUSTOMERS`

Delete customers from the workspace by providing their unique IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscribers` | array | Yes | A list of customer objects to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | The ID of the customer to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The current page number. Default 1; |
| `sort` | string | No | The sort option. Use ‘-’ for DESC. Default ‘-createdDate’; |
| `email` | string | No | Find a customer by the email address. |
| `limit` | integer | No | The items limit. Default 20; |
| `endDate` | string | No | ISO format or UNIX timestamp; |
| `startDate` | string | No | ISO format or UNIX timestamp; |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The current page number. Default 1 |
| `sort` | string | No | The sort option. Use ‘-’ for DESC. Default ‘-createdDate’ |
| `email` | string | No | Search responses by a customer’s email address |
| `limit` | integer | No | The items limit. Default 20 |
| `endDate` | string | No | The end date for the feedback, in UNIX timestamp format. |
| `startDate` | string | No | The start date for the feedback, in UNIX timestamp format. |
| `campaignId` | string | No | Filter responses by a specific campaign ID |
| `customerId` | string | No | Search responses by a customer’s Retently ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feedback_id` | string | Yes | The unique identifier of the feedback to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Outbox

**Slug:** `RETENTLY_GET_OUTBOX`

Retrieve the outbox of surveys that are scheduled to be sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The current page number. |
| `sort` | string | No | The sort option. Use -surveyCreatedDate for results in descending order. |
| `email` | string | No | Find a customer’s outbox records by email address. |
| `limit` | integer | No | The number of items per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | The end date for the report in YYYY-MM-DD format. |
| `start_date` | string | No | The start date for the report in YYYY-MM-DD format. |
| `campaign_id` | string | No | The ID of the campaign to get reports for. If not provided, reports for all campaigns will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delay` | integer | No | The delay in days to send the survey after the triggered event. |
| `campaign_id` | string | Yes | The ID of the campaign where the customers will be surveyed. |
| `subscribers` | array | Yes | A list of customers to send the survey to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unsubscribe Customers

**Slug:** `RETENTLY_UNSUBSCRIBE_CUSTOMERS`

Unsubscribe customers from receiving surveys by providing their email addresses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | No | Opt out message. |
| `subscribers` | array | Yes | An array of subscriber emails. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |