Skip to main content

Email Phases

EntityDatastoreDatastore.PhaseDatastore.Phase.ActivityEmail

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

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

Endpoints

List Email Phases

GET/v1/odata/Datastore_Phase_ActivityEmail

Single Phase

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

Fields

Inherited Fields (from Phase)

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

Relationships

RelationshipTarget EntityCardinalityDescription
EmailRecipient_Email1:NEmail

Expanding Relationships

GET/v1/odata/Datastore_Phase_ActivityEmail({id})?$expand=Email
GET/v1/odata/Datastore_Phase_ActivityEmail({id})/Email

Usage

Query Available Phases

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

Update Phase on Email

POST/v1/odata/Activity_Email

Filtering Examples

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

Custom Query

Build your own OData query against Datastore_Phase_ActivityEmail. Open Run and edit the whole request inline — swap the entity set, change the $filter, or add $expand, $select, $orderby, $top, $skip. Type $ for suggestions; use ↺ Reset to restore this example.

GET/v1/odata/Datastore_Phase_ActivityEmail?$top=10