Skip to main content

Campaigns

EntityActivityActivity.Campaign

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_Campaign

Single Campaign

GET/v1/odata/Activity_Campaign({id})

Create Campaign

POST/v1/odata/Activity_Campaign

Update 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

RelationshipTarget EntityCardinalityDescription
RelationshipRelationshipN:1Linked relation
PhaseDatastore.Phase.ActivityCampaignN:1Campaign phase
LinkedActivitiesActivity1:NLinked activities

Expanding Relationships

GET/v1/odata/Activity_Campaign({id})?$expand=Relationship
GET/v1/odata/Activity_Campaign({id})/Relationship

Filtering 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}