Persistiq

Learn how to use Persistiq with Composio

Overview

SLUG: PERSISTIQ

Description

PersistIQ is a sales automation platform that streamlines outbound sales processes with personalized email campaigns and task management.

Authentication Details

generic_api_key
stringRequired

Connecting to Persistiq

Create an auth config

Use the dashboard to create an auth config for the Persistiq toolkit. This allows you to connect multiple Persistiq accounts to Composio for agents to use.

1

Select App

Navigate to Persistiq.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Persistiq Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4persistiq_auth_config_id = "ac_YOUR_PERSISTIQ_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Persistiq for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, persistiq_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Persistiq toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["PERSISTIQ"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add Lead To Campaign

Description

Tool 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.

Action Parameters

campaign_id
stringRequired
lead
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Leads

Description

Tool to bulk create up to 10 leads. use when you have multiple new contacts and need optional duplicate-handling.

Action Parameters

duplicate_lead_action
stringDefaults to error
leads
arrayRequired

Action Response

data
arrayRequired
error
string
object
stringRequired
successful
booleanRequired

Tool Name: List Campaigns

Description

Tool to list campaigns. use when you need to fetch multiple campaigns with optional filters and pagination after setting up your filter criteria.

Action Parameters

lead_id
string
limit
integer
name
string
owner_id
string
page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Do Not Contact Domains

Description

Tool to list do not contact domains. use when you need to retrieve all domains marked as dnc.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Events

Description

Tool to retrieve a list of persistiq events. use when you need to fetch events filtered by group, campaign, lead, user, or time range.

Action Parameters

campaign
string
end_at
integer
group
string
lead
string
limit
integer
page
integer
start_at
integer
user
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Lead Fields

Description

Tool to list all lead fields for your company. use when you need to retrieve available custom lead fields.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Leads

Description

Tool to list leads from persistiq. use when you need to fetch a paginated list of leads, optionally filtering by status or updated after.

Action Parameters

limit
integerDefaults to 25
page
integerDefaults to 1
status
string
updated_after
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List lead statuses

Description

Tool to retrieve all lead statuses for your company. use when you need to list available lead statuses after confirming authentication with persistiq.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove Lead From Campaign

Description

Tool to remove a lead from a specified campaign. use when you need to detach a lead from an existing campaign after confirming both ids.

Action Parameters

campaign_id
stringRequired
lead_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Lead

Description

Tool 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.

Action Parameters

custom_fields
object
email
string
first_name
string
last_name
string
lead_id
stringRequired
organization_id
string
status
string
tags
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: View Lead

Description

Tool to retrieve a lead by its id. use when you have the lead id and need its detailed information.

Action Parameters

lead_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired