---
title: "Prepare outreach campaign"
method: POST
path: "/outreach/campaigns"
---

# Prepare outreach campaign

`POST /outreach/campaigns`

## Request

- Base URL: `https://api.bamf.ai/v1`
- URL: `https://api.bamf.ai/v1/outreach/campaigns`
- Auth: HTTP bearer

Prepares copy and cadence against an exact current signed list revision and connector account. Requires a signed-in BAMF user session and Idempotency-Key. Never sends.

## Headers

- `Idempotency-Key` string, required

## Request body

- OutreachCampaignPrepareRequest
  - `workspace_id` string, uuid, required
  - `session_id` string, uuid, required
  - `principal_context_ref_id` string, uuid, required
  - `binding` object, required
    - `search_list_id` string, uuid, required
    - `snapshot_id` string, uuid, required
    - `list_version` integer, required
    - `connector_provider` string, required
    - `connector_account_id` string, required
    - `channel` 'linkedin' | 'gmail' | 'x' | 'instagram', required
  - `plan` object, required
    - `copy` object[], required
      - `step` integer, required
      - `body` string, required
      - `subject` string
    - `cadence` object[], required
      - `step` integer, required
      - `delayMinutes` integer, required
    - `timezone` string, required
    - `resource_refs` string[]
    - `booking_ref` string, nullable

## Response `200`

Redacted prepared receipt; providerMutation is false

## Other responses

- `403`: JWT session or principal scope required

---

[API](https://skmtc.dev/bamf/apis/bamf-developer-platform-api.md) · [All operations](https://skmtc.dev/bamf/apis/bamf-developer-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bamf/apis/bamf-developer-platform-api/revisions/a390dd3294bd?raw)
