| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
?string | ➖ | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 |
remoteId |
?string | ➖ | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 |
name |
?string | ➖ | N/A | |
createdAt |
\DateTime | ➖ | The created_at date | 2021-01-01T01:01:01.000Z |
updatedAt |
\DateTime | ➖ | The updated_at date | 2021-01-01T01:01:01.000Z |
description |
?string | ➖ | N/A | |
scheduleType |
?Components\ScheduleType | ➖ | The schedule type | |
status |
?Components\CampaignStatus | ➖ | Status of the Campaign | |
archived |
bool|Components\Archived2|null | ➖ | N/A | |
draft |
bool|Components\Draft2|null | ➖ | N/A | |
channels |
array<Components\ChannelsEnum> | ➖ | channels of the Campaign | |
firstSentAt |
\DateTime | ➖ | The first_sent_at date | 2021-01-01T01:01:01.000Z |
lastSentAt |
\DateTime | ➖ | The last_sent_at date | 2021-01-01T01:01:01.000Z |
tags |
array<string> | ➖ | N/A | |
messages |
array<Components\Message> | ➖ | N/A | [ { "id": "message-id-1", "name": "SMS Message", "message_type": { "value": "sms", "sourceValue": "sms-message" }, "message_content": { "body": "This is an example SMS body.", "from": "1-555-123-4567" } }, { "id": "message-id-2", "name": "Email Message", "message_type": { "value": "email", "sourceValue": "email-message" }, "message_content": { "subject": "Example Email Subject", "body": "\u003ch1\u003eThis is an example\u003c/h1\u003e\n \u003cp\u003eemail body\u003c/p\u003e", "from": "Jane Smith", "reply-to": "reply@example.com", "preheader": "This is the preheader of the email." } }, { "id": "message-id-3", "name": "iOS Push Message", "message_type": { "value": "ios_push", "sourceValue": "ios-push" }, "message_content": { "body": "This is an example push notification body." } } ] |