---
title: "update a specific campaign"
method: PATCH
path: "/api/v1/campaigns/{id}"
tags: ["Campaigns"]
---

# update a specific campaign

`PATCH /api/v1/campaigns/{id}`

## Request

- Base URL: `http://localhost:3000`
- URL: `http://localhost:3000/api/v1/campaigns/{id}`
- Auth: `Bearer` (a scheme the document does not define)

## Request body

- object
  - `campaign` object, required
    - `identity_id` integer
    - `campaign_name` string
    - `campaign_template_id` integer
    - `start_date` unknown
    - `subject` string
    - `content` unknown
    - `body` unknown
    - `parent_id` integer
    - `metadata` object

## Response `200`

updated

- object
  - `status` string
  - `message` string
  - `data` object
    - `id` integer
    - `campaign_name` string
    - `status` string
    - `start_date` string, date-time
    - `end_date` string, date-time
    - `goal_description` string
    - `user_id` integer
    - `is_archived` string
    - `body` string
    - `subject` string
    - `schedules` unknown[]
      - unknown
    - `mail_count` integer
    - `sent_ids_pause` unknown[]
      - unknown
    - `campaign_schedule_days` unknown[]
      - unknown
    - `campaign_schedule_time` unknown[]
      - unknown
    - `from` string, date-time
    - `unsubscribe_sentence` string
    - `ancestry` string
    - `metadata` object
    - `bcc` object[]
    - `campaign_template_id` integer
    - `campaign_emails_count` integer
    - `campaign_recipients_count` integer
    - `identity_id` integer
    - `children_count` integer
    - `campaign_email_sents_count` integer
    - `campaign_email_scheduled_count` integer
    - `scheduled_at` string, date-time
    - `campaign_email_messages_count` integer
    - `created_at` string, date-time
    - `est_next_schedule` string, date-time
    - `metrics` object

## Other responses

- `422`: Error!

---

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