# Simplero

All-in-one marketing software for course creators, coaches and online marketers.

- **Category:** marketing automation
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 19
- **Triggers:** 0
- **Slug:** `SIMPLERO`
- **Version:** 20260227_00

## Tools

### Add Tag to Contact

**Slug:** `SIMPLERO_ADD_TAG_TO_CONTACT`

Tool to add a tag to a contact identified by email address. Use when you need to tag a contact for segmentation or tracking purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | The tag name to add to the contact |
| `email` | string | Yes | The contact's email address |

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

### Bulk Subscribe to List

**Slug:** `SIMPLERO_BULK_SUBSCRIBE_TO_LIST`

Tool to add multiple subscribers to a list in a single asynchronous request (max 1,000 per request). Use when you need to bulk import subscribers into a list. Returns a token to track the operation status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The ID of the list to add subscribers to. |
| `subscriber_data` | array | Yes | Collection of subscriber objects to add. Maximum of 1,000 entries per request. |

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

**Slug:** `SIMPLERO_CREATE_OR_UPDATE_ADMINISTRATOR`

Tool to create a new administratorship or update an existing one with the same email. Use when you need to add a new administrator to Simplero or update their role and permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Administrator's email address (required). Used to identify existing administrators. |
| `message` | string | No | Custom invitation message to include. Only applicable when creating new administrator. |
| `autogenerate` | boolean | No | Auto-generate username and password for new administrator. Only applicable when creating new administrator. |
| `invitee_name` | string | No | Name of new administrator. Required if autogenerate is true. Only applicable when creating new administrator. |
| `admin_role_id` | integer | Yes | ID of the administrative role to assign. Available roles: Co-Owner (1), Admin (2), Basic admin (3), Assistant (8), Support specialist (9), Affiliate manager (10). |
| `inviter_email` | string | No | Email of account administrator sending the invitation. Only applicable when creating new administrator. |
| `show_on_ticket` | boolean | No | Display administrator as support team member on tickets. Only applicable for creating or updating. |
| `ticket_assignee` | boolean | No | Enable ticket assignment capability for this administrator. Only applicable for creating or updating. |

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

**Slug:** `SIMPLERO_CREATE_OR_UPDATE_CONTACT`

Tool to create a new contact or update an existing contact with the same email. Use when you need to add a new contact to Simplero or update their information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ref` | integer | No | Affiliate reference identifier. |
| `note` | string | No | Additional notes about the contact. |
| `tags` | string | No | Comma-separated tag values to assign to the contact (e.g., 'tag1,tag2'). |
| `email` | string | Yes | Contact's email address (required). Used to identify existing contacts. |
| `phone` | string | No | Contact's phone number with country code prefix (e.g., '15551234567'). |
| `track` | string | No | Keyword to track opt-in source. |
| `override` | string | No | Set to 'yes' to replace existing values instead of merging. |
| `referrer` | string | No | Last external URL before subscription. |
| `last_name` | string | No | Contact's last name. |
| `first_name` | string | No | Contact's first name. |
| `ip_address` | string | No | IP address used during signup. |
| `gdpr_consent` | integer | No | GDPR consent status: 1 for consent granted, 0 for denied. |
| `landing_page_id` | integer | No | Landing page conversion tracking ID. |
| `gdpr_consent_text` | string | No | GDPR consent request text. |
| `first_activated_at` | string | No | ISO 8601 timestamp when contact first became active (e.g., '2023-01-15T10:30:00Z'). |
| `auto_responder_start_at` | string | No | ISO 8601 timestamp when autoresponder should begin (e.g., '2023-01-15T10:30:00Z'). |

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

### Find Contact By Email

**Slug:** `SIMPLERO_FIND_CONTACT_BY_EMAIL`

Tool to find and retrieve a contact by email address. Use when you need to look up contact details using an email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The contact's email address to search for. |

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

### Find Subscription By Email

**Slug:** `SIMPLERO_FIND_SUBSCRIPTION_BY_EMAIL`

Tool to find subscriptions for a specific list by email address. Use when you need to search for subscriptions associated with an email in a particular list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address to search for. |
| `list_id` | integer | Yes | The ID of the list to search within. |

#### 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 Administrator By ID

**Slug:** `SIMPLERO_GET_ADMINISTRATOR_BY_ID`

Tool to retrieve a single administratorship by internal ID. Use when you need detailed information about a specific administrator including user, account, role, and permission details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The administratorship ID 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 Administrators

**Slug:** `SIMPLERO_GET_ADMINISTRATORS`

Tool to retrieve all administratorships for the account. Use when you need to get information about account administrators, their roles, and permissions.

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

**Slug:** `SIMPLERO_GET_ADMIN_ROLES`

Tool to retrieve all available admin roles for the account including custom roles. Use when you need to list all admin roles such as Co-Owner, Admin, Basic admin, Assistant, Support specialist, Affiliate manager, or custom roles saved on Skyrocket plan.

#### 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 Async Request Status

**Slug:** `SIMPLERO_GET_ASYNC_REQUEST_STATUS`

Tool to check the status of an asynchronous API request. Use when you need to monitor the progress of a previously initiated async operation using its token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Request identifier received from the initial asynchronous request. This token is used to identify which async request status 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 Contact By ID

**Slug:** `SIMPLERO_GET_CONTACT_BY_ID`

Tool to retrieve a JSON representation of a contact by internal ID. Use when you need to fetch detailed information about a specific contact. Returns 404 if no contact exists with the provided ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The internal ID of the contact to retrieve. This ID is obtained from previous API calls. |

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

**Slug:** `SIMPLERO_GET_INVOICES`

Tool to get invoice information with optional filtering by date and invoice number. Use when you need to retrieve invoices from Simplero. Returns 20 invoices per page ordered by invoice number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dir` | string | No | Sort direction for results. Use 'asc' for ascending or 'desc' for descending (case-insensitive). Defaults to 'asc' if not specified. |
| `page` | integer | No | Page number for pagination. Returns 20 invoices per page. Defaults to 1 if not specified. |
| `created_at_to` | string | No | Return invoices created before this time. Must be an ISO-8601 datetime string (e.g., '2024-12-31T23:59:59Z'). |
| `created_at_from` | string | No | Return invoices created at or after this time. Must be an ISO-8601 datetime string (e.g., '2024-01-01T00:00:00Z'). |
| `invoice_number_to` | string | No | Return invoices with an invoice number alphabetically less than this value. |
| `invoice_number_from` | string | No | Return invoices with an invoice number alphabetically equal to or greater than this value. |

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

**Slug:** `SIMPLERO_GET_LISTS`

Tool to retrieve all mailing lists configured in the account. Use when you need to view all available lists for managing subscriptions and email 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 Products

**Slug:** `SIMPLERO_GET_PRODUCTS`

Tool to list all products in the account. Use when you need to retrieve information about all available products including their pricing.

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

### Remove Administrator

**Slug:** `SIMPLERO_REMOVE_ADMINISTRATOR`

Tool to delete an administratorship by ID. Use when you need to remove an administrator relationship from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The internal administratorship ID to remove. Must be obtained from a previous API call. |

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

### Remove Tag from Contact

**Slug:** `SIMPLERO_REMOVE_TAG_FROM_CONTACT`

Tool to remove a tag from a contact identified by email address. Use when you need to remove a specific tag from a contact's profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | The tag name to remove from the contact |
| `email` | string | Yes | The contact's email address |

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

### Subscribe to List

**Slug:** `SIMPLERO_SUBSCRIBE_TO_LIST`

Tool to add a new subscriber to a specific mailing list. Use when you need to subscribe a contact with their email address to a list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ref` | integer | No | Affiliate reference for conversion attribution. |
| `tags` | string | No | Comma-separated tag list (tags are trimmed of leading/trailing whitespace automatically). |
| `email` | string | Yes | Contact's email address (required). |
| `phone` | string | No | Sanitized phone number with country code first (e.g., '15551231234'). |
| `track` | string | No | Tracking keyword to identify subscription source. |
| `list_id` | integer | Yes | The ID of the mailing list to subscribe to. |
| `referrer` | string | No | Last external URL visited before subscription. |
| `last_name` | string | No | Contact's surname. |
| `first_name` | string | No | Contact's given name. |
| `ip_address` | string | No | Actual IP address that the customer used to subscribe. |
| `gdpr_consent` | boolean | No | GDPR consent indicator. |
| `landing_page_id` | integer | No | Landing page ID for conversion tracking. |
| `first_activated_at` | string | No | Initial activation timestamp in ISO 8601 format. |
| `auto_responder_start_at` | string | No | Automation sequence start date in ISO 8601 format. |

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

**Slug:** `SIMPLERO_UNSUBSCRIBE_FROM_LIST`

Tool to unsubscribe a customer from a specific mailing list. Use when you need to remove a contact from a list by their email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of the contact to remove from the list. |
| `list_id` | integer | Yes | The unique identifier of the list from which to unsubscribe the contact. |

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

### Update Contact Credentials

**Slug:** `SIMPLERO_UPDATE_CONTACT_CREDENTIALS`

Tool to update a contact's login credentials including email, first name, and last name. Use only with the consent of the contact. At least one identification parameter (email, id, or token) is required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Contact's internal ID. At least one of email, id, or token is required to identify the contact. |
| `email` | string | No | Contact's email address. At least one of email, id, or token is required to identify the contact. |
| `token` | string | No | Contact's token. At least one of email, id, or token is required to identify the contact. |
| `last_name` | string | No | Contact's last name to update. |
| `first_name` | string | No | Contact's first name to update. |
| `update_login_email` | boolean | No | Set to true to update the contact's login email address. Use this with the email parameter to change the login email. |

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