AppAutoGtm

Update Segment

patch/api/app-auto-gtm/segments/{segment_id}

Path parameters

segment_idinteger required

Cookies

ex_accessstring nullable
ex_orgstring nullable

Request body

instructionsstring nullable
followup_instructionsstring nullable
languagestring nullable
target_urlstring nullable
email_templatesobject nullable
report_frequencystring nullable
namestring nullable
descriptionstring nullable
painstring nullable
use_casestring nullable
positive_criteriasstring[] nullable
negative_criteriasstring[] nullable
example_clientsstring[] nullable
contextstring nullable
decision_makerstring nullable
target_geostring nullable
target_company_sizestring nullable

Response

Successful Response

namestring required

Short campaign / segment name (2-4 words)

painstring

Core pain this ICP has (max ~10 words)

use_casestring

What this ICP does with the product (max ~15 words)

keywordsstring

Comma-separated search keywords (5-8, lowercase, 1-3 words each)

positive_criteriasstring[]

Positive signals identifying this buyer (qualitative, 3-5 words each)

negative_criteriasstring[]

Disqualifying signals — look-alikes that are NOT a fit

example_clientsstring[]

Recognizable example companies that fit this ICP

decision_makerstring

Who to reach at the prospect, framed by responsibility

target_geostring

Target geographies — country names, comma-separated

target_company_sizestring

Target company size — free-text prompt, e.g. "mid-market and enterprise", "startups under 50"

idinteger required
descriptionstring required
contextstring
daily_limit_usdinteger required
pausedboolean
agent_turn_runningboolean
instructionsstring
followup_instructionsstring
languagestring
target_urlstring nullable
email_templatesobject
email_templates_versioninteger
updated_atstring
people_countinteger
report_frequencystring nullable

Changes

No recorded changes to this endpoint across all 2 revisions of this API.