---
title: "Create Campaign Engagement Attempt Batch"
method: POST
path: "/admin/engagement-attempt-batches/campaign"
tags: ["admin", "engagement-attempt-batches"]
---

# Create Campaign Engagement Attempt Batch

`POST /admin/engagement-attempt-batches/campaign`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/admin/engagement-attempt-batches/campaign`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Request body

- CreateCampaignEngagementAttemptBatchRequest
  - `organization_id` string, required
  - `agent_v2_id` string, required
  - `st_customer_ids` integer[], nullable
  - `contact_ids` string[], nullable
  - `variables` object, nullable
  - `variables_override_by_customer_id` object, nullable
  - `st_location_id_by_customer_id` object, nullable
  - `admin_opener_instruction` string, nullable
  - `lead_id` string, nullable
  - `source` string, nullable
  - `utm` object, nullable
  - `override_channel_id` string, nullable
  - `recent_contact_window_days` number, nullable
  - `idempotency_key` string, required
  - `runner_version` string
  - `is_simulated` boolean
  - `defer_initial_turn` boolean
  - `customer_initiated` boolean
  - `campaign_send_attempt_id` string, required

## Response `200`

Successful Response

- CreateEngagementAttemptBatchResponse
  - `id` string, required
  - `organization_id` string, required
  - `agent_v2_id` string, nullable
  - `status` string, required
  - `expected_attempts` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/cce8b07a5787?raw)