Skip to main content
PATCH
Update an AI Sales Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

AI Sales Agent ID

Example:

"01a0206f-e414-76cf-8ce7-a2439b5bad4c"

Body

application/json
name
string

Name of the AI Sales Agent

Example:

"Enterprise Outreach Agent"

description
string | null

Description of the AI Sales Agent

Example:

"Targets enterprise companies in tech sector"

config
object

Configuration for the AI Sales Agent including memory, enrichment settings, outreach settings, and autonomy settings. If not provided, default configuration will be used.

self_improvement
boolean | null

When enabled, the agent learns from past campaign performance to iteratively improve its outreach strategy.

Example:

false

status
enum<number>

Status of the AI Sales Agent. Setting 0 (inactive) pauses the agent and its campaigns; setting 1 (active) resumes them.

Available options:
-1,
0,
1
Example:

1

Response

The updated AI Sales Agent

An AI Sales Development Representative that autonomously manages outreach campaigns

id
string<uuid>
required
read-only

Unique identifier for the AI Sales Agent

Example:

"01a0206f-abee-7ca8-a46b-c5a19837747c"

workspace_id
string<uuid>
required
read-only

Workspace ID that owns this AI Sales Agent

Example:

"01a0206f-abee-7ca8-a46b-c5a2813e57b1"

name
string
required

Name of the AI Sales Agent

Example:

"Enterprise Outreach Agent"

status
enum<number>
required
read-only

Status of the AI Sales Agent

Available options:
-1,
0,
1
Example:

1

initial_scrape_ready
boolean
required
read-only

Indicates whether the initial website scrape has been completed

Example:

false

timestamp_created
string<date-time>
required
read-only

Timestamp when the AI Sales Agent was created

Example:

"2026-08-20T18:29:44.558Z"

timestamp_updated
string<date-time>
required
read-only

Timestamp when the AI Sales Agent was last updated

Example:

"2026-08-20T18:29:44.558Z"

description
null | string

Description of the AI Sales Agent

Example:

"Targets enterprise companies in tech sector"

type
enum<string>

The type of business details extraction method used (website scraping or pitch deck). Required unless memory_from_workspace is true.

Available options:
website,
pitch_deck
Example:

"website"

input
null | string

The input used for creation: URL for website scraping or text content for pitch deck extraction. Required unless memory_from_workspace is true.

Example:

"https://example.com"

config
object

Configuration for the AI Sales Agent including memory, enrichment settings, outreach settings, and autonomy settings. If not provided, default configuration will be used.

created_by
null | string<uuid>
read-only

User ID who created the AI Sales Agent

Example:

"01a0206f-abee-7ca8-a46b-c5a3101fdcc4"

master_lead_list_id
null | string<uuid>
read-only

ID of the master lead list associated with this AI Sales Agent

Example:

"01a0206f-abee-7ca8-a46b-c5a4c7ba91c8"

agent_type
enum<number>

The agent type. 2 = Sales Agent, 4 = Affiliate Agent, 7 = Recruiting Agent, 8 = Investment Agent, 9 = User Research Agent, 10 = Partnership Agent. Defaults to 2 (Sales Agent) if not provided.

Available options:
2,
4,
7,
8,
9,
10
Example:

2

self_improvement
null | boolean

When enabled, the agent learns from past campaign performance to iteratively improve its outreach strategy.

Example:

false

timestamp_last_action
null | string<date-time>
read-only

Timestamp of the last action taken by the AI Sales Agent

Example:

"2026-08-20T18:29:44.558Z"

timestamp_last_decision
null | string<date-time>
read-only

Timestamp of the last decision made by the AI Sales Agent

Example:

"2026-08-20T18:29:44.558Z"

next_decision_time
null | string<date-time>
read-only

Timestamp of the next scheduled decision time

Example:

"2026-08-20T18:29:44.558Z"