|
1 | 1 | {
|
2 | 2 | "properties": {
|
3 | 3 | "id": {
|
| 4 | + "description": "The unique identifier of the campaign", |
4 | 5 | "type": ["null", "integer"]
|
5 | 6 | },
|
6 | 7 | "createdAt": {
|
| 8 | + "description": "The timestamp when the campaign was created", |
7 | 9 | "type": ["null", "integer"]
|
8 | 10 | },
|
9 | 11 | "updatedAt": {
|
| 12 | + "description": "The timestamp when the campaign was last updated", |
10 | 13 | "type": ["null", "integer"]
|
11 | 14 | },
|
12 | 15 | "startAt": {
|
| 16 | + "description": "The timestamp when the campaign will start", |
13 | 17 | "type": ["null", "integer"]
|
14 | 18 | },
|
15 | 19 | "endedAt": {
|
| 20 | + "description": "The timestamp when the campaign ended", |
16 | 21 | "type": ["null", "integer"]
|
17 | 22 | },
|
18 | 23 | "name": {
|
| 24 | + "description": "The name of the campaign", |
19 | 25 | "type": ["null", "string"]
|
20 | 26 | },
|
21 | 27 | "templateId": {
|
| 28 | + "description": "The ID of the template used for the campaign", |
22 | 29 | "type": ["null", "integer"]
|
23 | 30 | },
|
24 | 31 | "messageMedium": {
|
| 32 | + "description": "The medium used to deliver the campaign message (e.g., email, SMS)", |
25 | 33 | "type": ["null", "string"]
|
26 | 34 | },
|
27 | 35 | "createdByUserId": {
|
| 36 | + "description": "The ID of the user who created the campaign", |
28 | 37 | "type": ["null", "string"]
|
29 | 38 | },
|
30 | 39 | "updatedByUserId": {
|
| 40 | + "description": "The ID of the user who last updated the campaign", |
31 | 41 | "type": ["null", "string"]
|
32 | 42 | },
|
33 | 43 | "campaignState": {
|
| 44 | + "description": "The current state of the campaign (e.g., draft, active, paused)", |
34 | 45 | "type": ["null", "string"]
|
35 | 46 | },
|
36 | 47 | "listIds": {
|
| 48 | + "description": "List of IDs of the lists targeted by the campaign", |
37 | 49 | "type": ["null", "array"],
|
38 | 50 | "items": {}
|
39 | 51 | },
|
40 | 52 | "suppressionListIds": {
|
| 53 | + "description": "List of IDs of suppression lists for the campaign", |
41 | 54 | "type": ["null", "array"],
|
42 | 55 | "items": {}
|
43 | 56 | },
|
44 | 57 | "sendSize": {
|
| 58 | + "description": "The size of the audience targeted by the campaign", |
45 | 59 | "type": ["null", "number"]
|
46 | 60 | },
|
47 | 61 | "recurringCampaignId": {
|
| 62 | + "description": "If the campaign is recurring, the ID of the parent recurring campaign", |
48 | 63 | "type": ["null", "number"]
|
49 | 64 | },
|
50 | 65 | "workflowId": {
|
| 66 | + "description": "The ID of the workflow associated with the campaign", |
51 | 67 | "type": ["null", "number"]
|
52 | 68 | },
|
53 | 69 | "labels": {
|
| 70 | + "description": "List of labels associated with the campaign", |
54 | 71 | "type": ["null", "array"],
|
55 | 72 | "items": {}
|
56 | 73 | },
|
57 | 74 | "type": {
|
| 75 | + "description": "The type of campaign (e.g., one-time, recurring)", |
58 | 76 | "type": ["null", "string"]
|
59 | 77 | }
|
60 | 78 | },
|
|
0 commit comments