Skip to main content

Campaign Phases

Entity›Datastore›Datastore.Phase›Datastore.Phase.ActivityCampaign

Campaign Phases define the workflow stages for Campaigns. Use this endpoint to query the available phases and their IDs, which are needed to update the phase of a campaign.

Use the Datastore_Phase_ActivityCampaign endpoint to query phases for this activity type.

Endpoints​

List Campaign Phases​

GET/v1/odata/Datastore_Phase_ActivityCampaign

Single Phase​

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

Fields​

Inherited Fields (from Phase)​

See Phase Fields for all inherited fields including Name, Code, Icon, ActionName, IsAssignable, and IsTerminal.

Relationships​

RelationshipTarget EntityCardinalityDescription
CampaignActivity_Campaign1:NCampaign

Expanding Relationships​

GET/v1/odata/Datastore_Phase_ActivityCampaign({id})?$expand=Campaign
GET/v1/odata/Datastore_Phase_ActivityCampaign({id})/Campaign

Usage​

Query Available Phases​

GET /v1/odata/Datastore_Phase_ActivityCampaign?$select=Name,Code,IsTerminal

Update Phase on Campaign​

POST /v1/odata/ActivityCampaign
{
  "ID": "{activity-id}",
  "Phase": {
    "ID": "{phase-id}"
  }
}

Filtering Examples​

GET/v1/odata/Datastore_Phase_ActivityCampaign?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Datastore_Phase_ActivityCampaign?$filter=Code eq '{Code}'&$top={top}
GET/v1/odata/Datastore_Phase_ActivityCampaign?$filter=IsTerminal eq {IsTerminal}&$top={top}
GET/v1/odata/Datastore_Phase_ActivityCampaign?$filter=IsAssignable eq {IsAssignable}&$top={top}
GET/v1/odata/Datastore_Phase_ActivityCampaign?$filter=IsDefault eq {IsDefault}&$top={top}