---
title: "Update Signature Campaign"
method: PATCH
path: "/signatures/campaigns/{campaign_id}"
tags: ["Signatures"]
---

# Update Signature Campaign

`PATCH /signatures/campaigns/{campaign_id}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/signatures/campaigns/{campaign_id}`
- Auth: HTTP bearer

Replace a campaign's content or schedule. Send the ``revision`` you read.

## Path parameters

- `campaign_id` string, uuid, required: Signature campaign id

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- SignatureCampaignWrite: Create or update a signature banner campaign.
  - `version` integer: Revision you last read. Ignored on create.
  - `data` SignatureCampaign, required: A time-boxed banner campaign injected into managed signatures.
    - `name` string, required
    - `block` Block, required
      - `id` string, required
      - `kind` 'identity' | 'contact' | 'photo' | 'logo' | 'social' | 'cta' | 'banner' | 'divider' | 'disclaimer' | 'green_footer' | 'custom_html', required
      - `text` string
      - `url` string
      - `image` string
      - `locked` boolean
      - `required` boolean
    - `starts_at` string, date-time, required
    - `ends_at` string, date-time, required
    - `status` 'draft' | 'scheduled' | 'paused'
    - `priority` integer
    - `mailbox_ids` integer[]
    - `recipient_domains` string[]
    - `excluded_domains` string[]
    - `external_only` boolean
    - `departments` string[]
    - `recipient_list_ids` integer[]
    - `native_static` boolean

## Response `200`

Successful Response

- ApiResponseSignatureCampaignResponse
  - `data` SignatureCampaignResponse, required
    - `id` string, required
    - `revision` integer, required
    - `data` object, required: The stored campaign document.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

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