Skip to main content
Persistiq logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: PERSISTIQ
  • Version: 20261101_00

Tools

Slug: PERSISTIQ_ADD_LEAD_TO_CAMPAIGNTool to add a lead to a specified campaign. Use when you have lead details and a campaign ID to enroll the lead into the campaign.

Input Parameters

object
required
Details of the lead to add to a campaign.
string
required
The unique identifier of the campaign to which the lead will be added.

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: PERSISTIQ_CREATE_CAMPAIGNTool to create a new campaign in PersistIQ. Use when you need to set up a new outreach campaign with a specific owner.

Input Parameters

string
required
The ID of the user who will own this campaign. Can be obtained from GET /v1/users endpoint
string
required
The name of the campaign to create

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: PERSISTIQ_CREATE_DNC_DOMAINTool to create a Do Not Contact domain. Use when you need to block emails from being sent to addresses at a specific domain without manual approval.

Input Parameters

string
required
Do Not Contact domain name (e.g., example.com)

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: PERSISTIQ_CREATE_LEADSTool to bulk create up to 10 leads. Use when you have multiple new contacts and need optional duplicate-handling.

Input Parameters

array
required
List of up to 10 leads to create
string ("error" | "update" | "ignore")
Behavior when a duplicate email is found: ‘error’, ‘update’, or ‘ignore’

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: PERSISTIQ_LIST_CAMPAIGNSTool to list campaigns. Use when you need to fetch multiple campaigns with optional filters and pagination after setting up your filter criteria.

Input Parameters

string
Filter campaigns by campaign name (partial, case-insensitive match)
integer
Page number for pagination (starting at 1)
integer
Number of records per page (max 100)
string
Filter campaigns by associated lead ID
string
Filter campaigns by owner user ID

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: PERSISTIQ_LIST_DNC_DOMAINSTool to list Do Not Contact domains. Use when you need to retrieve all domains marked as DNC.

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: PERSISTIQ_LIST_EVENTSTool to retrieve a list of PersistIQ events. Use when you need to fetch events filtered by group, campaign, lead, user, or time range.

Input Parameters

string
Only return events related to this lead (UUID)
integer
Page of results to return
string
Only return events performed by this user (UUID)
string
Only return events belonging to this group (UUID)
integer
Number of results per page (max 100)
integer
Only return events before this Unix timestamp (seconds since epoch)
string
Only return events from this campaign (UUID)
integer
Only return events after this Unix timestamp (seconds since epoch)

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: PERSISTIQ_LIST_LEAD_FIELDSTool to list all lead fields for your company. Use when you need to retrieve available custom lead fields.

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: PERSISTIQ_LIST_LEADSTool to list leads from PersistIQ. Use when you need to fetch a paginated list of leads, optionally filtering by status or updated_after.

Input Parameters

integer
Page number to retrieve.
integer
Max number of leads per page (1-100).
string ("active" | "archived")
Filter leads by status; valid values are ‘active’ or ‘archived’.
string
Return leads updated after this datetime (ISO 8601).

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: PERSISTIQ_LIST_LEAD_STATUSESTool to retrieve all lead statuses for your company. Use when you need to list available lead statuses after confirming authentication with PersistIQ.

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: PERSISTIQ_LIST_USERSTool to list all non-archived users in your company. Use when you need to retrieve user information including id, name, email, activated status, default_mailbox_id, and salesforce_id.

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: PERSISTIQ_REMOVE_LEAD_FROM_CAMPAIGNTool to remove a lead from a specified campaign. Use when you need to detach a lead from an existing campaign after confirming both IDs.

Input Parameters

string
required
The unique identifier of the lead to be removed from the campaign.
string
required
The unique identifier of the campaign from which the lead will be removed.

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: PERSISTIQ_UPDATE_LEADUpdate an existing lead by ID, modifying its first name, last name, email, company name, phone, or title.

Input Parameters

string
Lead’s email address
string
Lead’s phone number
string
Lead’s job title
string
required
ID of the lead to update
string
Lead’s last name
string
Lead’s first name
string
Lead’s company name

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: PERSISTIQ_VIEW_LEADTool to retrieve a lead by its ID. Use when you have the lead ID and need its detailed information.

Input Parameters

string
required
Unique identifier of the lead 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