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

# Preview Signature Setup

`POST /signatures/setup-preview`

## Request

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

Dry-run an assignment against the mail provider before committing it.

Confirms the employee account and send-as alias resolve, and returns the
signature currently installed there. Write capability stays unverified until
a real deployment succeeds. A provider refusal answers 422 with the state and
reason rather than a stack trace.

## Headers

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

## Request body

- SignatureSetupPreviewRequest: Check that a mailbox's provider account and send-as alias are usable.
  - `mailbox_id` integer, required
  - `data` SignatureAssignment, required: Which employee a mailbox signs as, and which template it renders.
    - `member_id` string, uuid, required
    - `template_id` string, uuid, nullable
    - `account_subject` string, required
    - `send_as_email` string, required
    - `integration_id` string, uuid, nullable
    - `overrides` object
    - `native_requested` boolean

## Response `200`

Successful Response

- ApiResponseDict
  - `data` object, required
  - `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)