Campaigns

Create campaign

Changed on

Creates a campaign and linked email from at most one of prompt, HTML, Sequenzy blocks, or an existing template. Omit all content sources to create an empty draft. Optional From/Reply-To inputs create or select profiles; From addresses require a verified sending domain. Defaults to draft. Use status sent only to archive an imported/already-sent campaign. Marketer account keys must choose existing sender and Reply-To profiles; requests requiring new profiles return 400 before creating profiles, labels, or campaign/sequence changes, including nested steps and branches.

post/campaigns

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/campaigns
  • Auth
    HTTP bearer

Request body

namestring required
subjectstring

Required with HTML, blocks, or templateId; optional with prompt, where it overrides the generated subject.

previewTextstring nullable

Optional inbox preview text saved on the linked email.

preheaderTextstring nullable

Compatibility alias for previewText.

trackingCodestring nullable

Optional campaign tracking code available to UTM templates as {{campaign.trackingCode}}. Empty strings are stored as null.

status'draft' | 'sent'

Initial status. Defaults to draft. Use sent only for imported/already-sent campaigns.

sentAtstring date-time nullable

ISO date-time for an imported/already-sent campaign. Only valid with status sent; defaults to now when omitted.

htmlstring

Raw HTML body. Mutually exclusive with blocks.

blocksobject[]

Sequenzy email blocks. Mutually exclusive with html. Put visual styling under styles; top-level style keys such as backgroundColor, backgroundOpacity, borderColor, borderWidth, and borderRadius are normalized into styles.

promptstring

Natural-language request for branded native campaign blocks.

stylestring

Generation style; valid only with prompt. Pass designed or plain to force the designed or plain-text email style; other values are freeform prompt guidance. Defaults to the company's email style preference.

tonestring

Generation tone; valid only with prompt.

emailPreset'branded' | 'minimal'

Per-email Style > Format for native Sequenzy blocks. This is separate from the prompt-generation style field. Cannot be combined with html, and a template or blocks payload stored as one standalone raw HTML block does not support it. Applying minimal removes standalone logo blocks; switching back to branded generates a new logo unless the authored logo block is sent again.

campaignDataobject nullable
computedListsobject[]
labelsstring[]

Label names to assign. Missing labels are created automatically.

labelstring[]

Compatibility alias for labels.

templateIdstring

Company-owned email template to copy into the campaign. Mutually exclusive with prompt, HTML, and blocks. The content snapshot of a code-managed transactional email (created by sends with trackAs) is rejected with 400, because it holds one recipient's real content.

segmentIdstring

Shorthand for targeting one saved segment. Equivalent to targetLists {"type":"segment","segmentId":"seg_123"}. Mutually exclusive with targetLists and listIds.

listIdsstring[]

Shorthand for targeting one or more lists. Equivalent to targetLists {"type":"lists","listIds":["list_123"]}. Mutually exclusive with targetLists and segmentId.

targetListsobject

Campaign audience saved on the draft. Omit to leave targeting unset and choose it when scheduling. The object is a union discriminated on type: {"type":"all"}, {"type":"lists","listIds":["list_123"]}, {"type":"segment","segmentId":"seg_123"}, {"type":"filtered","filters":[],"filterJoinOperator":"and"}, {"type":"rules","include":[],"exclude":[]}. Mutually exclusive with segmentId and listIds.

fromEmailstring email

Campaign From address. Its domain must be configured and verified.

fromNamestring

Display name recipients see, e.g. 'Brennon at TradeTally'. Selects the sender identity of that name on fromEmail, creating it when the address has no identity by that name; the mailbox's other display names, and everything pinned to them, are untouched. Requires fromEmail; omit it when using senderProfileId, which already carries its own display name.

senderProfileIdstring

Existing sender profile ID. It already supplies both the From address and display name, so send it on its own and omit fromEmail and fromName.

replyTostring email

Campaign Reply-To address. A reply profile is created when needed.

replyToNamestring

Display name for the Reply-To address. Requires replyTo; omit it when using replyProfileId, which already carries its own display name. An address carries one Reply-To name company-wide, so if replyTo already has a saved profile under a different name, that saved name is kept and the response warnings array says so.

replyProfileIdstring

Existing reply profile ID. It already supplies both the Reply-To address and display name, so send it on its own and omit replyTo and replyToName.

Response

Campaign created

successboolean
warningsstring[]

Non-blocking advisories about a successful write. Present when an input was discarded or did not take effect as requested. This includes block fields that do not render as their names suggest, sequence email-step formatting restored on top of submitted blocks, and sender-identity conflicts such as a replyToName that differs from the saved profile. Each message identifies the affected input and gives recovery guidance. Absent when there is nothing to report.

Example response

{
  "success": true,
  "campaign": {
    "emailPreset": "branded",
    "status": "draft",
    "labels": [
      "edm",
      "api"
    ],
    "url": "https://sequenzy.com/dashboard/company/comp_abc123/campaign/camp_abc123",
    "previewUrl": "https://sequenzy.com/dashboard/company/comp_abc123/campaign/camp_abc123?step=review"
  },
  "warnings": [
    "blocks[0].styles.color is not a supported field and was ignored. Button label color comes from the block-level `buttonTextColor` field. Supported styles fields: backgroundColor, backgroundOpacity, bleed, borderColor, borderRadius, borderWidth, keepAlign, paddingBottom, paddingLeft, paddingRight, paddingTop, textAlign, textColor."
  ]
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • f1d8cfd9faafRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • warning

      added the new undefined enum value to the / response property for the response status