Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-173334181.2 MB

30deeb9d1e3b

Reach: Campaigns

Get campaign details

Get a single campaign with its sender, subject, template reference, targeting and delivery progress.

This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.

get/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}

Path parameters

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

Profile uuid parameter

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

Campaign uuid parameter

Response

Success response

uuidstring
titlestring
subjectstring
sender_namestring
sender_emailstring
template_uuidstring nullable

The email template this campaign uses. The template title is not exposed.

status'draft' | 'scheduled' | 'sending' | 'publish' | 'failed'

A fully sent campaign is publish. There is no sent, paused or archived status.

type'campaign' | 'automation' | 'double_opt_in'
failure_reasonstring nullable

Set only while the status is failed.

is_smart_sendboolean

Whether delivery time is picked per contact rather than sent to everyone at once.

is_all_contactsboolean

Whether the campaign targets every contact instead of the listed segments.

segment_uuidsstring[]

Segments this campaign targets. Empty when it targets all contacts.

created_atstring date-time
updated_atstring date-time nullable
sent_atstring date-time nullable
scheduled_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": "publish",
  "type": "campaign",
  "failure_reason": "sending_limit_reached",
  "delivery": {
    "total_sent": 100,
    "estimated_total_recipients": 900,
    "subscribers_count": 900
  },
  "segment_uuids": [
    "2080cc86-e026-4f7b-9598-d4132f8c7c2f"
  ],
  "created_at": "2025-02-27T11:54:22Z",
  "updated_at": "2025-03-04T09:12:07Z",
  "sent_at": "2025-03-04T09:12:07Z",
  "scheduled_at": "2025-03-04T08:00:00Z"
}