NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Persistiq connects to a Nagent workspace with an API key. Once it is connected, agents can call 14 Persistiq actions, such as "Add Lead To Campaign", "Create Campaign" and "Create Do Not Contact Domain". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Persistiq, with input parameters and output schema.
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
Details of the lead to add to a campaign.
The unique identifier of the campaign to which the lead will be added.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The ID of the user who will own this campaign. Can be obtained from GET /v1/users endpoint
The name of the campaign to create
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Do Not Contact domain name (e.g., example.com)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSISTIQ_CREATE_LEADSTool to bulk create up to 10 leads. Use when you have multiple new contacts and need optional duplicate-handling.
Input parameters
List of up to 10 leads to create
Behavior when a duplicate email is found: 'error', 'update', or 'ignore'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Filter campaigns by campaign name (partial, case-insensitive match)
Page number for pagination (starting at 1)
Number of records per page (max 100)
Filter campaigns by associated lead ID
Filter campaigns by owner user ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSISTIQ_LIST_DNC_DOMAINSTool to list Do Not Contact domains. Use when you need to retrieve all domains marked as DNC.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Only return events related to this lead (UUID)
Page of results to return
Only return events performed by this user (UUID)
Only return events belonging to this group (UUID)
Number of results per page (max 100)
Only return events before this Unix timestamp (seconds since epoch)
Only return events from this campaign (UUID)
Only return events after this Unix timestamp (seconds since epoch)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSISTIQ_LIST_LEAD_FIELDSTool to list all lead fields for your company. Use when you need to retrieve available custom lead fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page number to retrieve.
Max number of leads per page (1-100).
Filter leads by status; valid values are 'active' or 'archived'.
Return leads updated after this datetime (ISO 8601).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique identifier of the lead to be removed from the campaign.
The unique identifier of the campaign from which the lead will be removed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSISTIQ_UPDATE_LEADTool to update a lead's information. Use when you need to modify fields (status, tags, or custom attributes) of an existing lead. Call after confirming the lead_id.
Input parameters
Lead's email address
Lead's phone number
Lead's job title
ID of the lead to update
Lead's last name
Lead's first name
Lead's company name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PERSISTIQ_VIEW_LEADTool to retrieve a lead by its ID. Use when you have the lead ID and need its detailed information.
Input parameters
Unique identifier of the lead to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 14 Persistiq actions on Nagent, including "Add Lead To Campaign", "Create Campaign" and "Create Do Not Contact Domain". Add Lead To Campaign: Add a lead to a specified campaign. Each action is listed on this page with its input parameters and its output.
Persistiq connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Add Lead To Campaign takes 2 required inputs: lead and campaign_id. It returns data, error and successful.