Signatures

Preview Signature Campaign

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.

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

versioninteger

Revision you last read. Ignored on create.

mailbox_idinteger nullable

Evaluate the campaign's targeting rules against this mailbox. Omit to render only.

recipientsstring[]

Candidate recipient addresses to test the targeting rules against.

campaign_idstring uuid nullable

Exclude this campaign from the priority comparison when previewing an edit.

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.