A campaign.
| Attribute | Type | Description |
|---|---|---|
| message | string | The message sent to subscribers |
| name | string | Name of the campaign |
| status | string | The current campaign status Possible values: ["ACTIVE", "COMPLETED", "DRAFT", "ERROR", "INACTIVE", "IN_PROGRESS", "SCHEDULED", "STOPPED", "SUSPENDED", "ARCHIVED"] |
| organization.uid | string | Podium unique identifier for the referenced resource. |
| uid | string | Podium unique identifier for campaign. |
| locations | array | Reference to the locations resource. |
| locations[].uid | string | Podium unique identifier for the referenced resource. |
| createdAt | string | Time at which the resource was created. Date time is in Coordinated Universal Time (UTC). |
| updatedAt | string | Time at which the resource was updated. Date time is in Coordinated Universal Time (UTC). |
| endedAt | string | Time at which the campaign completed, stopped or errored. Date time is in Coordinated Universal Time (UTC). |
| startedAt | string | Time at which the campaign messsages started sending. Date time is in Coordinated Universal Time (UTC). |
{
"message": "Get 50% off this memorial day weekend!",
"name": "Memorial Day sale",
"status": "ACTIVE",
"organization": {
"uid": "00000000-0000-0000-0000-000000000000"
},
"uid": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z",
"endedAt": "2015-01-23T23:50:07Z",
"startedAt": "2015-01-23T23:50:07Z"
}