Sign in
Agent Chat

Stop Segment Endpoint

Reliably STOP a campaign regardless of status — unlike /pause, which is outreach-only and 409s for discovery/searching/review (leaving the campaign to autonomously search → review → auto-approve → send).

Halts everything that could still cause a send, idempotently:

  1. interrupt any running agent turn (discovery/searching/review/resuming) so the lead search / review work stops;
  2. if it's actively sending (outreach) → pause (→ listening) and cancel the queued outreach emails;
  3. freeze any pending review's auto-approve countdown so a review segment can't tick over into outreach.

Safe to call from any status and repeatedly. Re-enable via /start.

Thin adapter: the orchestration lives in segment_control.stop_campaign (shared with the public API); this endpoint only translates the cookie session into an org_id and maps domain errors to HTTP.

post/api/agent-chat/segments/{segment_id}/stop

Path parameters

segment_idstring required

Cookies

ex_accessstring nullable
ex_orgstring nullable

Response

Successful Response

{"stackTrail":"paths:/api/agent-chat/segments/{segment_id}/stop:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.