Set Pitch Config

Sets how the ICP's AI steps write copy: the copy frameworks, tones and trigger reasons to write from, and the goal the emails ask for. Every combination of trigger reason, framework and tone becomes a pitch, and each prospect is written from one of them. See "AI copy and pitch configs" in the introduction.

An ICP has one pitch config, and this call replaces it, so it is safe to repeat. Any field you leave out takes the default: AIDA, PAS and HEART frameworks, informal and direct tones, the Cold Contact trigger and the schedule_call goal. Name the goal either with goalId (from List Pitch Goals) or by writing a custom one in goal and description; a custom goal with the same label as an existing one reuses it.

Replacing a config marks the unsent AI emails written from the old pitches for regeneration. Call Rebuild Step Emails for each AI step to carry it out, which spends AI credits. Emails already sent are never touched.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Get this from Settings > Workspaces. Starts with "account_".

string
required

Get this from Settings > Workspaces > Workspace ID column. On read endpoints you may also pass the literal value all to span every workspace in the account.

Body Params
string
required

The ICP this pitch config belongs to.

copyFrameworks
array of objects
length ≥ 1

At least one. Defaults to aida, pas and heart.

copyFrameworks
Allowed:
tones
array of objects
length ≥ 1

At least one. Defaults to informal and direct.

tones
Allowed:
triggerReasons
array of objects

Defaults to Cold Contact.

triggerReasons
string

A goal id from List Pitch Goals. Defaults to schedule_call.

string
length ≥ 1

A custom goal's label, instead of goalId, e.g. "Book a 15-minute site visit". Created in the ICP's workspace, or reused if one with this label exists.

string

What the custom goal asks the prospect to do, used when writing the copy. Only read together with goal.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json