Creates an engagement topic record that connects a given topic ID. For example, a service appointment ID, to a messaging session ID. If an engagement topic for this connection already exists, no action is taken.
This action is available in API version 63.0 and later.
Supported REST HTTP Methods
URI: /services/data/vXX.X/actions/standard/createEngagementTopic
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer TOKEN
Where TOKEN is a variable.
Inputs
| Input | Type | Description |
|---|---|---|
topicId |
id | Required. The topic’s ID. |
Outputs
| Output | Type | Description |
|---|---|---|
completionStatus |
boolean | Defines whether the engagement topic was created successfully. |
Example
Sample request body:
{
"inputs" : [{
"topicId" : "08p000000000001AAA"
}]
}
Sample response body:
{
"actionName" : "createEngagementTopic",
"errors" : null,
"isSuccess" : true,
"outputValues" : {
"completionStatus" : true
}
}