Create one Outreach (campaign container) in draft.

REUSE BEFORE CREATE: an Outreach is a commercial thread. Before creating one, call GET /outreach (or GET /search?type=outreach) and reuse the existing Outreach whenever it already represents the same thread — same audience, same angle, same reason. Create a new one only when no existing Outreach represents it.

This creates the CONTAINER ONLY. No targets, executions, actions, messages or sends are created implicitly. Attach targets afterwards with POST /targets using the returned id as campaignId, and record real sends with POST /outreach/{id}/executions.

The server always sets the state: outreach_status = draft, status = active, ownership = the credential's user, workspace = the credential's workspace, created_by = the credential's user. An Outreach can never be created in ready_to_send, waiting_for_responses or executed state — those are facts derived from recorded executions, not declarable at creation.

post/outreach

Request

  • Base URL: https://forbiz.io/api/public/agent
  • URL: https://forbiz.io/api/public/agent/outreach
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Recommended on every mutating request. A replay with the same key is NOT applied twice: the server answers { ok, idempotent_replay: true, first_seen_at, status } describing the first attempt.

Request body

namestring

Required. The commercial thread this Outreach represents.

reasonNowstring

Why this Outreach exists now.

expectedSignalsstring[]

Free-form strings. Not validated against a fixed list.

funnelIdstring nullable

Optional. Must belong to the caller when given.

channelModestring

Optional. Defaults to copy_paste, matching the UI.

verticalstring
intendedAudiencestring
productAnglestring
messageAnglestring
callToActionstring
senderNamestring
senderEmailstring

Response

Outreach created in draft. Container only.

okboolean
outreachobject
createdobject

Changes

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