Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inqueue EntityType
A list of records that require action, such as accounts, activities, and cases.
- Entity set path:
- [organization URI]/api/data/v9.2/queues
- Base type:
- crmbaseentity
- Display name:
- Queue
- Primary key:
- queueid
- Primary name column:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| createdon | Edm.DateTimeOffset |
Date and time when the queue was created. Display name: Created On Read only
|
||||||||||||
| description | Edm.String |
Description of the queue. Display name: Description |
||||||||||||
| emailaddress | Edm.String |
Email address that is associated with the queue. Display name: Incoming Email |
||||||||||||
| emailrouteraccessapproval | Edm.Int32 |
Shows the status of the primary email address. Display name: Primary Email Status
Default options
|
||||||||||||
| entityimage | Edm.Binary |
The default image for the entity. Display name: Entity Image |
||||||||||||
| entityimage_timestamp | Edm.Int64 |
Read only
|
||||||||||||
| entityimage_url | Edm.String |
Read only
|
||||||||||||
| entityimageid | Edm.Guid |
For internal use only. Display name: Entity Image Id Read only
|
||||||||||||
| exchangerate | Edm.Decimal |
Exchange rate for the currency associated with the queue with respect to the base currency. Display name: Exchange Rate Read only
|
||||||||||||
| ignoreunsolicitedemail | Edm.Boolean |
Information that specifies whether a queue is to ignore unsolicited email (deprecated). Display name: Convert To Email Activities
Default options
|
||||||||||||
| importsequencenumber | Edm.Int32 |
Unique identifier of the data import or data migration that created this record. Display name: Import Sequence Number |
||||||||||||
| incomingemaildeliverymethod | Edm.Int32 |
Incoming email delivery method for the queue. Display name: Incoming Email Delivery Method
Default options
|
||||||||||||
| incomingemailfilteringmethod | Edm.Int32 |
Convert Incoming Email To Activities Display name: Convert Incoming Email To Activities
Default options
|
||||||||||||
| isemailaddressapprovedbyo365admin | Edm.Boolean |
Shows the status of approval of the email address by O365 Admin. Display name: Email Address O365 Admin Approval Status Read only
Default options
|
||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the queue was last modified. Display name: Modified On Read only
|
||||||||||||
| name | Edm.String |
Name of the queue. Display name: Name |
||||||||||||
| numberofitems | Edm.Int32 |
Number of Queue items associated with the queue. Display name: Queue Items Read only
|
||||||||||||
| numberofmembers | Edm.Int32 |
Number of Members associated with the queue. Display name: No. of Members Read only
|
||||||||||||
| outgoingemaildeliverymethod | Edm.Int32 |
Outgoing email delivery method for the queue. Display name: Outgoing Email Delivery Method
Default options
|
||||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||||||||
| queueid | Edm.Guid |
Unique identifier of the queue. Display name: Queue |
||||||||||||
| queuetypecode | Edm.Int32 |
Type of queue that is automatically assigned when a user or queue is created. The type can be public, private, or work in process. Display name: Queue Type Read only
Default options
|
||||||||||||
| queueviewtype | Edm.Int32 |
Select whether the queue is public or private. A public queue can be viewed by all. A private queue can be viewed only by the members added to the queue. Display name: Type
Default options
|
||||||||||||
| statecode | Edm.Int32 |
Status of the queue. Display name: Status
Default options
|
||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the queue. Display name: Status Reason
Default options
|
||||||||||||
| versionnumber | Edm.Int64 |
Version number of the queue. Display name: Version Number Read only
|
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the queue record. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the queue. |
| _defaultmailbox_value | defaultmailbox |
Select the mailbox associated with this queue. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who last modified the queue. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who last modified the queue. |
| _organizationid_value | organizationid |
Unique identifier of the organization associated with the queue. |
| _ownerid_value | ownerid |
Unique identifier of the user or team who owns the queue. |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier of the business unit that owns the queue. |
| _transactioncurrencyid_value | transactioncurrencyid |
Unique identifier of the currency associated with the queue. |
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| businessunitid | businessunit | business_unit_queues |
| createdby | systemuser | lk_queuebase_createdby |
| createdonbehalfby | systemuser | lk_queue_createdonbehalfby |
| defaultmailbox | mailbox | queue_defaultmailbox_mailbox |
| modifiedby | systemuser | lk_queuebase_modifiedby |
| modifiedonbehalfby | systemuser | lk_queue_modifiedonbehalfby |
| organizationid | organization | organization_queues |
| ownerid | principal | owner_queues |
| owningbusinessunit | businessunit | business_unit_queues2 |
| primaryuserid | systemuser | queue_primary_user |
| transactioncurrencyid | transactioncurrency | TransactionCurrency_Queue |
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| email_acceptingentity_queue | acceptingentityid | |
| mailbox_regarding_queue | mailbox | regardingobjectid_queue |
| queue_activity_parties | activityparty | partyid_queue |
| Queue_AsyncOperations | asyncoperation | regardingobjectid_queue |
| Queue_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_queue |
| Queue_DuplicateBaseRecord | duplicaterecord | baserecordid_queue |
| Queue_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_queue |
| Queue_Email_EmailSender | emailsender_queue | |
| queue_entries | queueitem | queueid |
| queue_PostFollows | postfollow | regardingobjectid_queue |
| queue_PostRegardings | postregarding | regardingobjectid_queue |
| queue_principalobjectattributeaccess | principalobjectattributeaccess | objectid_queue |
| Queue_ProcessSessions | processsession | regardingobjectid_queue |
| Queue_SyncErrors | syncerror | regardingobjectid_queue_syncerror |
| queue_system_user | systemuser | queueid |
| queue_team | team | queueid |
| queuemembership_association | systemuser | queuemembership_association |
The following operations can be used with the queue entity type.
| Name | Binding |
|---|---|
| AddPrincipalToQueue | Bound to Entity |
| GrantAccess | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RetrieveUserQueues | Not Bound |
| RevokeAccess | Not Bound |