Field Service Developer Guide

Field Service Developer Guide
PDF

Create Engagement Topic

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

Inputs

Input Details
topicId
Type
id
Description
Required. The topic’s ID.

Outputs

Output Details
completionStatus
Type
boolean
Description
Defines whether the engagement topic was created successfully.

Example

Sample request body:

1{
2  "inputs" : [{
3    "topicId" : "08p000000000001AAA"
4  }]
5}

Sample response body:

1{
2  "actionName" : "createEngagementTopic",
3  "errors" : null,
4  "isSuccess" : true,
5  "outputValues" : {
6    "completionStatus" : true
7  }
8}