Skip to main content

Emailing Categories

EntityDatastoreDatastore.EmailingCategory

Emailing categories classify campaigns and manage email subscription preferences on relationships.

Use the Datastore_EmailingCategory endpoint to query emailing categories.

Endpoints

List Emailing Categories

GET/v1/odata/Datastore_EmailingCategory

Single Emailing Categorie

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

Fields

Datastore Fields (inherited)

FieldTypeDescription
NameStringDisplay name
CodeStringUnique code identifier
LocalizedNameStringLocalized display name
IsDefaultBooleanWhether this is the default value

Relationships

RelationshipTarget EntityCardinalityDescription
CampaignActivity_Campaign1:NCampaign
RelationshipRelationship1:NRelationship

Expanding Relationships

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

Filtering Examples

GET/v1/odata/Datastore_EmailingCategory?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Datastore_EmailingCategory?$filter=contains(Name, '{Name}')&$top={top}
GET/v1/odata/Datastore_EmailingCategory?$filter=Code eq '{Code}'&$top={top}
GET/v1/odata/Datastore_EmailingCategory?$filter=IsDefault eq {IsDefault}&$top={top}