The REST API supports create, retrieve, update and delete operations for campaigns.
Accessing Campaigns
- GET /assets/campaign/{id}?depth={depth}
Response
The response for this call looks as follows
{ "type": "Campaign", "currentStatus": "Draft", "id": "6", "createdAt": "1284079044", "createdBy": "9", "depth": "complete", "description": "add a description...", "folderId": "1132", "name": "Sample Campaign", "updatedAt": "1292311276", "updatedBy": "9", "actualCost": "0.00", "budgetedCost": "0.00", "campaignType": "", "isMemberAllowedReEntry": "true", "isReadOnly": "false", "product": "", "region": ""
}
Properties
Name | Type | Description | Notes | Validations |
| type | "Campaign" | |||
| actualCost | decimal | The actual cost of the campaign | Integer Requirement | |
| budgetedCost | decimal | The budgeted cost for the campaign | Integer Requirement | |
| campaignType | string | |||
| crmId | string | The unique id of the campaign in your CRM | ||
| elements | List of Campaign Element | |||
| endAt | integer | The campaign's end date | DateRequirement | |
| fieldValues | List of FieldValue | |||
| isMember AllowedReEntry | boolean | Determines whether a member can re-enter the campaign | Boolean Requirement | |
| isReadOnly | boolean | Boolean Requirement | ||
| product | string | |||
| region | string | |||
| startAt | integer | The campaign's start date | DateRequirement | |
| accessedAt | integer | DateRequirement | ||
| createdAt | integer | ReadOnly | DateRequirement | |
| createdBy | integer | ReadOnly | IdRequirement | |
| currentStatus | string | |||
| depth | RequestDepth | Enum Requirement | ||
| description | string | |||
| folderId | integer | IdRequirement | ||
| id | integer | IdRequirement | ||
| name | string | |||
| permissions | Instance Permissions | Enum Requirement | ||
| scheduledFor | integer | DateRequirement | ||
| sourceTemplateId | string | |||
| updatedAt | integer | ReadOnly | DateRequirement | |
| updatedBy | integer | ReadOnly | IdRequirement |
Related Operations
- POST : /assets/campaign
- PUT : /assets/campaign/{id}
- DELETE : /assets/campaign/{id}
- GET : /assets/campaigns?depth={depth}&count={count}&page={page}&search={search}&orderBy={orderBy}&lastUpdatedAt={lastUpdatedAt}
- GET : /assets/campaigns/assets/campaigns/recent?depth={depth}&count={count}