v4

OpenAPI 3.1.02026-07-3163216290.7 KB

Campaigns

Get a campaign

Retrieve a single campaign by ID.

get/v1/campaigns/{campaignId}

Response

Successful.

idstring required

The ID of the campaign.

namestring required

The name of the campaign.

status'Draft' | 'Scheduled' | 'Sending' | 'Sent' required

The status of the campaign.

createdAtstring date-time required

ISO 8601 timestamp for when the campaign was created.

updatedAtstring date-time required

ISO 8601 timestamp for when the campaign was last updated.

emailMessageIdstring nullable required

The associated email message ID.

campaignGroupIdstring nullable required

The ID of the campaign group this campaign belongs to.

mailingListIdstring nullable required

The ID of the mailing list this campaign sends to, if set.

audienceSegmentIdstring nullable required

The ID of the audience segment this campaign targets, if set.

Example response

{
  "id": "clc4m6n8p0q2r4s6t8u0v2x4",
  "name": "Spring announcement",
  "status": "Draft",
  "createdAt": "2025-06-29T07:47:39.370Z",
  "updatedAt": "2025-06-29T07:47:39.370Z",
  "emailMessageId": "cle5f7g9h1i3j5k7l9m1n3p5",
  "campaignGroupId": "clg7n5p3q1r9s7t5u3v1w9y7",
  "mailingListId": "clm2k8j4h6g0f8d6s4a2b0z8",
  "audienceSegmentId": null,
  "audienceFilter": null,
  "scheduling": {
    "method": "now",
    "timestamp": null
  }
}