Skip to main content
Endorsal logo
  • Category: reviews
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 26
  • Triggers: 0
  • Slug: ENDORSAL
  • Version: 20261101_00

Tools

Slug: ENDORSAL_ARCHIVE_CONTACTTool to archive a contact using its unique identifier. Use when you need to remove a contact from active use without permanently deleting it.

Input Parameters

string
required
The unique identifier of the contact to archive.

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: ENDORSAL_CREATE_CONTACTTool to create a new contact in your Endorsal account. Use when you need to add a new contact with their email, name, and company details. Optionally add the contact to an AutoRequest campaign by providing the campaign ID.

Input Parameters

string
required
Email address of the contact. This is required to create a contact.
string
Phone number of the contact.
string
Company name of the contact.
string
Job title or position of the contact.
string
Last name of the contact.
string
First name of the contact.
string
Pass in an AutoRequest campaign ID to automatically add the contact to that campaign.

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: ENDORSAL_CREATE_TAGTool to create a new tag in Endorsal. Tags can be used to categorize testimonials or represent products. Use when you need to add a new organizational category or product tag.

Input Parameters

string
External ID/SKU (typically used for product type tags)
URL link to product page (typically used for product type tags)
string
required
Name of the tag
string ("tag" | "product")
required
Type of tag: ‘tag’ for general categorization or ‘product’ for product-specific tags
string
URL to image (typically used for product type tags)
string
Description of the tag

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: ENDORSAL_CREATE_TESTIMONIALTool to submit a new testimonial. Use when adding customer feedback to your Endorsal account after gathering input.

Input Parameters

string
Job title of the individual
string
required
Name of the individual giving the testimonial
string
required
Email address of the individual
integer
Rating value (1-5)
string
Company name of the individual
string
Profile image URL
string
Website URL of the individual or company
Whether the testimonial is featured
string
Location of the individual
string
required
The ID of the property to associate with this testimonial. Can be obtained from the List Properties action.
string
required
The testimonial text

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: ENDORSAL_DELETE_TAGTool to delete a tag using its unique identifier. Use when you need to remove a tag from the system permanently.

Input Parameters

string
required
The unique identifier of the tag to delete

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: ENDORSAL_DELETE_TESTIMONIALTool to permanently delete a testimonial by its ID. Use when you need to remove a testimonial from your Endorsal account. This action cannot be undone.

Input Parameters

string
required
The unique identifier of the testimonial to delete. Obtain this from list endpoints or after creating a testimonial.

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: ENDORSAL_GET_AUTO_REQUEST_CAMPAIGNTool to retrieve a specific AutoRequest campaign by its unique identifier. Use when you need to fetch details of an existing AutoRequest campaign.

Input Parameters

string
required
The unique identifier of the AutoRequest campaign (MongoDB ObjectID format: 24 hexadecimal characters).

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: ENDORSAL_GET_CONTACTTool to retrieve details of a specific contact by its unique identifier. Use when you have the contact ID and need to fetch complete contact details.

Input Parameters

string
required
Unique identifier of the contact 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: ENDORSAL_GET_TAGTool to retrieve details of a specific tag by its unique identifier. Use when you have a tag ID and need full tag metadata.

Input Parameters

string
required
The unique identifier of the tag 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: ENDORSAL_GET_TESTIMONIALRetrieves complete details of a specific testimonial by its ID. Returns the testimonial content, author information (name, email, company, job, location), rating, approval status, and timestamps. Use this after obtaining a testimonial ID from listing endpoints or creation operations.

Input Parameters

string
required
The unique testimonial ID to retrieve. Obtain this from list endpoints or after creating a testimonial.

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: ENDORSAL_GET_WALL_OF_LOVERetrieves the Wall of Love for a property, returning testimonials that match its configuration options. Optionally returns a fully rendered HTML widget. Use render=false (default) to get testimonial data as JSON for custom display, or render=true to get a complete HTML/CSS/JS bundle ready to embed on your website.

Input Parameters

boolean
If true, the API returns a fully rendered Wall of Love bundled with required JavaScript and CSS files that can be inserted directly into your website. If false or omitted, returns testimonial data as JSON.

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: ENDORSAL_GET_WIDGETTool to retrieve details of a specific widget by its unique identifier. Use when you need full widget details before editing or analysis.

Input Parameters

string
required
The unique identifier for the widget in MongoDB ObjectID format (24 hexadecimal characters)

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: ENDORSAL_LIST_ALL_TAGSTool to retrieve a list of all Tag Objects across all properties in your Endorsal account. Use when you need to view all available tags regardless of property association.

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: ENDORSAL_LIST_AUTOREQUEST_CAMPAIGNSTool to retrieve a list of all AutoRequest campaigns. Use when you need to view both active and inactive 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: ENDORSAL_LIST_CONTACTSLists contacts for a specified Endorsal property, with optional pagination, to browse contact details. Provide a property ID, obtainable from List Properties; page numbers start at 1 and page size can be set from 1 to 100.

Input Parameters

integer
Page number for pagination (1-indexed). Defaults to 1 if not specified.
integer
Number of contacts to return per page (1-100). Defaults to API default if not specified.
string
required
Unique identifier for the property to filter contacts by. Obtain this from the List Properties action.

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: ENDORSAL_LIST_CONTACT_TESTIMONIALSRetrieves testimonials associated with a specific Endorsal contact, with optional pagination. Use it to view a contact’s feedback history; obtain the contact ID from List Contacts.

Input Parameters

integer
Page number for pagination (1-based index)
integer
Number of testimonials per page
string
required
Unique identifier of the contact (typically a 24-character hexadecimal ID). Obtain from the List Contacts action.

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: ENDORSAL_LIST_PROPERTIESTool to retrieve all properties for the authenticated account. Use after obtaining a valid API key and login.

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: ENDORSAL_LIST_TAGSRetrieves all tags associated with a specific property in Endorsal. Tags are used to categorize and organize testimonials. Use this action when you need to view available tags for a property before assigning them to testimonials, or to get a complete list of tags for filtering purposes.

Input Parameters

string
required
The unique identifier for the property whose tags you want to list.

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: ENDORSAL_LIST_TAG_TESTIMONIALSTool to retrieve all testimonials for a given tag. Use when you need to list testimonials filtered by tag ID for pagination and display.

Input Parameters

integer
Page number for paginated results. Defaults to 1.
integer
Number of items per page. Defaults to 50, maximum is 100.
string
required
The unique identifier of the tag to filter testimonials by.

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: ENDORSAL_LIST_TESTIMONIALSRetrieves a paginated list of all testimonials in your Endorsal account. Use when you need to browse testimonials, generate reports, or manage customer feedback.

Input Parameters

integer
Page number for pagination (1-based index). Defaults to 1 if not specified.
integer
Number of testimonials to return per page (1-100). Defaults to 20 if not specified.

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: ENDORSAL_LIST_WIDGETSRetrieves all testimonial display widgets associated with your Endorsal account. Widgets are used to display collected testimonials on your website. This action returns basic information about each widget including its ID, name, status, and timestamps. No parameters required - retrieves all widgets for the authenticated account. Use this when you need to: - Enumerate available widgets for management or selection - Get widget IDs for use with other widget operations - Check widget statuses across your account

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: ENDORSAL_SEARCH_CONTACTSTool to search contacts using query Match Objects. Returns matching Contact Objects based on field, operator, and value criteria. Use when you need to find specific contacts by email, name, company, or other fields with flexible matching operators.

Input Parameters

array
required
Array of Match Objects defining search criteria. Each Match Object contains field, operator, and value. Multiple conditions are combined with AND logic.

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: ENDORSAL_SEARCH_TESTIMONIALSTool to search testimonials using query Match Objects. Returns matching Testimonial Objects. Use when you need to filter testimonials by specific criteria like rating, approval status, property ID, or any other testimonial field.

Input Parameters

array
required
Array of Match Objects to filter testimonials. Each object specifies a field, operator, and value for matching

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: ENDORSAL_TAG_TESTIMONIALTool to add tag(s) to a testimonial. Use when you need to categorize or associate tags with a testimonial. Supports both existing tags (by _id) and creating new tags inline.

Input Parameters

array
required
Array of tag objects. Use ExistingTagReference (with _id) for existing tags or NewTagObject (with name, type, etc.) to create new tags
string
required
The unique identifier of the testimonial to tag

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: ENDORSAL_UPDATE_CONTACTTool to update a contact’s information. Pass in fields you’d like to update using a ‘fields’ object. Use when you need to modify existing contact details.

Input Parameters

string
required
ID of the contact to update.
object
required
Object containing fields to update (e.g., name, email, phone, position, company, location, website, etc.).

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: ENDORSAL_UPDATE_TESTIMONIALTool to update an existing testimonial. Pass in only the fields you want to update using the ‘fields’ object. Use this when modifying testimonial content, author information, rating, or approval status.

Input Parameters

string
required
ID of the testimonial to update
object
required
Object containing fields to update. Include only the fields you want to change.

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