Sign in
Reach: Campaigns

Create a draft campaign

Create a campaign in a profile.

The campaign is created as a draft, so nothing is sent and no contact is touched. It has no audience yet either - targeting and scheduling are not part of this request, the draft is finished and sent from the Reach interface.

post/api/reach/v1/profiles/{profileUuid}/campaigns

Path parameters

profileUuidstring required
Example:550e8400-e09b-41d4-a716-400055000000

Profile uuid parameter

Request body

sender_namestring required

From name shown to the recipients.

sender_emailstring required

From address of the campaign. Its domain has to be verified on the profile before the campaign can be sent.

titlestring

Name the campaign is listed under. Not shown to the recipients.

subjectstring

Subject line of the email.

template_uuidstring

Template to send, as returned by the template endpoints. Can be left out and attached later, but the campaign cannot be sent without one.

Example request

{
  "sender_name": "Marketing Team",
  "sender_email": "marketing@example.com",
  "title": "Black Friday Campaign",
  "subject": "Don't miss our Black Friday deals!",
  "template_uuid": "550e8400-e29b-41d4-a716-446655440000",
  "metadata": {
    "preheader": "Our biggest deals of the year",
    "source": "api"
  }
}

Response

Success response

uuidstring
titlestring
subjectstring
sender_namestring
sender_emailstring
template_uuidstring nullable
status'draft' | 'scheduled' | 'sending' | 'publish' | 'failed'

Always draft for a campaign that was just created.

type'campaign' | 'automation' | 'double_opt_in'
is_all_contactsboolean

Whether the campaign targets every contact instead of selected segments.

metadataobject

The stored extra fields, including the ones Reach sets itself.

created_atstring date-time nullable
updated_atstring date-time nullable

Example response

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Black Friday Campaign",
  "subject": "Don't miss our Black Friday deals!",
  "sender_name": "Marketing Team",
  "sender_email": "marketing@example.com",
  "template_uuid": "2080cc86-e026-4f7b-9598-d4132f8c7c2f",
  "status": "draft",
  "type": "campaign",
  "metadata": {
    "preheader": "Our biggest deals of the year"
  },
  "created_at": "2025-02-27T11:54:22Z",
  "updated_at": "2025-03-04T09:12:07Z"
}

Changes

Changed in 1 of the 94 revisions of this API.1