---
title: "Create a lead-gen campaign"
method: POST
path: "/contacts/campaigns"
tags: ["contacts"]
---

# Create a lead-gen campaign

`POST /contacts/campaigns`

Create a campaign with optional agent context (markdown brief)..

## Request body

- object
  - `name` string, required — Human-readable campaign name. Use a clear, descriptive title. Do NOT use slugs or technical IDs.
  - `description` string — Optional campaign description
  - `language` string — ISO 639-1 language code (e.g. 'fr', 'en'). Overrides ASCII heuristic for AI task language.
  - `force` boolean — Bypass the duplicate-name guard. Normally the endpoint returns 409 with a `suggested` existing campaign when `name` is within Levenshtein 2 of one. Pass `force: true` after the agent has surfaced the suggestion to the user and they explicitly confirmed they want a second campaign with a similar name. Default: false.
  - `draftMode` 'review' — Drafted messages wait for a human to approve them before they may send.

## Response `201`

Campaign created

- object
  - `success` true, required
  - `campaign` object, required
    - `id` string, required — Campaign unique ID (nanoid). Use this as campaignSlug in API calls.
    - `name` string, required — Human-readable campaign name.
    - `slug` string, nullable — URL-safe slug auto-generated from name.
    - `description` string, nullable, required — Optional user-facing campaign description.
    - `status` string, required — Campaign status: running, paused, offline, broken, or completed.
    - `totalContacts` integer, required — How many people are on this list, including removed.
    - `scheduledStartTime` string, nullable — Daily start time (HH:MM)
    - `scheduledStopTime` string, nullable — Daily stop time (HH:MM)
    - `timezone` string, nullable — IANA timezone
    - `runDays` string[], nullable — Days to run (e.g. ['monday','tuesday'])
    - `dailyActionLimit` integer, nullable — Max actions per day
    - `startedAt` string, nullable — When campaign was first started
    - `completedAt` string, nullable — When campaign was completed
    - `draftMode` 'review' | 'autopilot' — Drafted messages wait for a human to approve them before they may send.
    - `stageCounts` object
      - `contact` integer, required
      - `lead` integer, required
      - `qualified` integer, required
      - `rejected` integer, required
    - `language` string, nullable
    - `icpContextId` string, nullable — The ICP this campaign judges against.
    - `disabledTasks` string[] — Task kinds switched off on this campaign.
    - `brokenReasons` string[] — Why the campaign is broken, when it is. Empty when it is not.
    - `hiddenIdentities` integer — Contacts held back because their identity could not be resolved.
    - `lastTaskAt` string, nullable
    - `nextAction` unknown
    - `leadCapacity` object, nullable — Whether this campaign can still reach new people, and from how many live sources.
      - `potential` integer
      - `collected` integer
      - `qualified` integer
      - `activeSources` integer
    - `createdAt` string, required
    - `updatedAt` string, required
  - `creditsUsed` integer, required — Credits consumed by this call. 0 for free endpoints, cached results, duplicates, and for every query that does not touch LinkedIn.
  - `retryAfter` integer, required — Seconds to wait before another call of the same type. 0 means no wait is needed.
  - `_meta` object — Credit balance carried on every response so a caller never has to ask for it separately. Absent when the caller has no connected account.
    - `credits` object, required
      - `current` number, required — Credits spent this period.
      - `limit` number, nullable, required — Period allowance, or null when unlimited.
      - `remaining` number, nullable, required — Allowance left, or null when unlimited.
      - `percentage` number, required — Share of the allowance spent, 0 to 100.
      - `isUnlimited` boolean, required
      - `accountPlan` string, required — The credential's plan.

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error.
- `401` — Although HTTP specifies "unauthorized", this response means "unauthenticated". Authenticate to continue. NOTE: 401 is also returned with code "linkedin_not_connected" when the caller IS authenticated but has no connected LinkedIn account — connect LinkedIn (not re-authenticate) to continue.
- `403` — The client does not have access rights to the content.
- `404` — The server cannot find the requested resource.
- `409` — The request conflicts with the current state of the server.
- `410` — The requested content has been permanently deleted from the server.
- `422` — The request was well-formed but was unable to be followed due to semantic errors.
- `429` — Rate limit exceeded. Read error.retryAfter for the wait time in seconds.
- `500` — The server encountered a situation it does not know how to handle.
- `502` — LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.
- `503` — Proxy capacity temporarily exceeded. Retry after a few seconds.

---

[API](https://skmtc.net/berea/apis/bereach-api.md) · [All operations](https://skmtc.net/berea/apis/bereach-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/berea/bereach-api/revisions/9217eedacbb8/schema)