Campaigns
Campaigns represent marketing campaigns and outreach initiatives in your CRM. They can track targets, costs, and results of marketing efforts.
Use the Activity_Campaign endpoint to manage campaigns. Campaigns inherit all fields from Activity.
Endpoints
List Campaigns
GET
/v1/odata/Activity_CampaignSingle Campaign
GET
/v1/odata/Activity_Campaign({id})Create Campaign
POST
/v1/odata/Activity_CampaignUpdate Campaign
PUT
/v1/odata/Activity_Campaign({id})Delete Campaign
DELETE
/v1/odata/Activity_Campaign({id})Fields
Inherited Fields (from Activity)
See Activity Fields for all inherited fields.
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| Relationship | Relationship | N:1 | Linked relation |
| Phase | Datastore.Phase.ActivityCampaign | N:1 | Campaign phase |
| LinkedActivities | Activity | 1:N | Linked activities |
Expanding Relationships
GET
/v1/odata/Activity_Campaign({id})?$expand=RelationshipNavigating Relationships
GET
/v1/odata/Activity_Campaign({id})/RelationshipFiltering Examples
GET
/v1/odata/Activity_Campaign?$filter=contains(Subject, '{Subject}')&$top={top}GET
/v1/odata/Activity_Campaign?$filter=IsClosed eq {IsClosed}&$top={top}GET
/v1/odata/Activity_Campaign?$filter=Amount gt {Amount}&$top={top}