Connect REST API Developer Guide
jNewer Version Available
Engagement Channel Types
Retrieve a list of the engagement channel types from your Salesforce
org. The API returns only the channel types that are active and whose usage type is set
to Salesforce Scheduler.
- Resource
-
1/connect/scheduling/engagement-channel-types - Examples
-
1https://yourInstance.salesforce.com/services/data/v56.0/connect/scheduling/engagement-channel-types -
1https://yourInstance.salesforce.com/services/data/v56.0/connect/scheduling/engagement-channel-types?workTypeGroupIds=0VSRM0000000BgX4AU -
1https://yourInstance.salesforce.com/services/data/v56.0/connect/scheduling/engagement-channel-types?workTypeIds=08q2w000000XmniAAC,08q2w000000XmniAAS - Available version
- 56.0
- Requires Chatter
- No
- HTTP methods
- GET
- Request parameters for GET
-
Parameter Name Type Description Required or Optional Available Version workTypeGroupIds String List of the work type group IDs. The API returns the list of engagement channel type records that are associated with the specified work type group IDs. For example, suppose that you have three engagement channel types: EC1, EC2, and EC3. If you pass work type group IDs WTG1 that is associated with EC1 and EC2 and WTG2 that is associated with EC2, the API returns the list of engagement channel types where:- EC1 is with WTG1 only
- EC2 is with both WTG1 and WTG2
Optional 56.0 workTypeIds String List of the work type IDs. The API returns the engagement channel type records that are associated with the specified work type IDs. For example, suppose that you have three engagement channel types: EC1, EC2, and EC3. If you pass work type IDs WT1 that is associated with EC1 and EC3 and WT2 that is associated with EC3, the API returns the list of engagement channel types where:- EC1 is with WT1 only
- EC3 is with both WT1 and WT2
Optional 56.0 - Response body for GET
- Engagement Channel Type Output