Skip to main content
Simplero logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 19
  • Triggers: 0
  • Slug: SIMPLERO
  • Version: 20261030_00

Tools

Slug: SIMPLERO_ADD_TAG_TO_CONTACTTool 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

string
required
The tag name to add to the contact
string
required
The contact’s email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_BULK_SUBSCRIBE_TO_LISTTool 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

integer
required
The ID of the list to add subscribers to.
array
required
Collection of subscriber objects to add. Maximum of 1,000 entries per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_CREATE_OR_UPDATE_ADMINISTRATORTool 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

string
required
Administrator’s email address (required). Used to identify existing administrators.
string
Custom invitation message to include. Only applicable when creating new administrator.
boolean
Auto-generate username and password for new administrator. Only applicable when creating new administrator.
string
Name of new administrator. Required if autogenerate is true. Only applicable when creating new administrator.
integer
required
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).
string
Email of account administrator sending the invitation. Only applicable when creating new administrator.
boolean
Display administrator as support team member on tickets. Only applicable for creating or updating.
boolean
Enable ticket assignment capability for this administrator. Only applicable for creating or updating.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_CREATE_OR_UPDATE_CONTACTTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_FIND_CONTACT_BY_EMAILTool to find and retrieve a contact by email address. Use when you need to look up contact details using an email address.

Input Parameters

string
required
The contact’s email address to search for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_FIND_SUBSCRIPTION_BY_EMAILTool 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

string
required
The email address to search for.
integer
required
The ID of the list to search within.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_GET_ADMINISTRATOR_BY_IDTool 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

integer
required
The administratorship ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_GET_ADMINISTRATORSTool to retrieve all administratorships for the account. Use when you need to get information about account administrators, their roles, and permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_GET_ADMIN_ROLESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_GET_ASYNC_REQUEST_STATUSTool 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

string
required
Request identifier received from the initial asynchronous request. This token is used to identify which async request status to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_GET_CONTACT_BY_IDTool 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

integer
required
The internal ID of the contact to retrieve. This ID is obtained from previous API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_GET_INVOICESTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_GET_LISTSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_GET_PRODUCTSTool to list all products in the account. Use when you need to retrieve information about all available products including their pricing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_REMOVE_ADMINISTRATORTool to delete an administratorship by ID. Use when you need to remove an administrator relationship from the system.

Input Parameters

integer
required
The internal administratorship ID to remove. Must be obtained from a previous API call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_REMOVE_TAG_FROM_CONTACTTool 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

string
required
The tag name to remove from the contact
string
required
The contact’s email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_SUBSCRIBE_TO_LISTTool 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

integer
Affiliate reference for conversion attribution.
string
Comma-separated tag list (tags are trimmed of leading/trailing whitespace automatically).
string
required
Contact’s email address (required).
string
Sanitized phone number with country code first (e.g., ‘15551231234’).
string
Tracking keyword to identify subscription source.
integer
required
The ID of the mailing list to subscribe to.
string
Last external URL visited before subscription.
string
Contact’s surname.
string
Contact’s given name.
string
Actual IP address that the customer used to subscribe.
GDPR consent indicator.
integer
Landing page ID for conversion tracking.
string
Initial activation timestamp in ISO 8601 format.
string
Automation sequence start date in ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_UNSUBSCRIBE_FROM_LISTTool 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

string
required
The email address of the contact to remove from the list.
integer
required
The unique identifier of the list from which to unsubscribe the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLERO_UPDATE_CONTACT_CREDENTIALSTool 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

integer
Contact’s internal ID. At least one of email, id, or token is required to identify the contact.
string
Contact’s email address. At least one of email, id, or token is required to identify the contact.
string
Contact’s token. At least one of email, id, or token is required to identify the contact.
string
Contact’s last name to update.
string
Contact’s first name to update.
boolean
Set to true to update the contact’s login email address. Use this with the email parameter to change the login email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not