---
title: "Preview Signature Campaign"
method: POST
path: "/signatures/campaigns/preview"
tags: ["Signatures"]
---

# Preview Signature Campaign

`POST /signatures/campaigns/preview`

## Request

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

Render a campaign banner and, optionally, test who it would reach.

Reads only. With ``mailbox_id`` set, ``matching`` explains whether the
campaign would apply to that sender and the supplied ``recipients``, and
which campaign wins on priority.

## Headers

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

## Request body

- SignatureCampaignPreviewRequest: Render a campaign banner without saving it, optionally against a mailbox.
  - `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
  - `mailbox_id` integer, nullable: Evaluate the campaign's targeting rules against this mailbox. Omit to render only.
  - `recipients` string[]: Candidate recipient addresses to test the targeting rules against.
  - `campaign_id` string, uuid, nullable: Exclude this campaign from the priority comparison when previewing an edit.

## Response `200`

Successful Response

- ApiResponseSignatureCampaignPreviewResponse
  - `data` SignatureCampaignPreviewResponse, required
    - `html` string, required
    - `plain` string, required
    - `native_static` boolean, required
    - `matching` object, nullable: Targeting evaluation. Null unless mailbox_id was supplied.
  - `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/2e7cfa0ca921?raw)