Engagement Topic Create Input | Industries Common Resources Developer Guide

Root XML tag

<engagementTopic>

JSON Example

1{
2  "engagementTopics": {
3    "topicId": "testTopicId",
4    "relatedPersonId": "testRelatedPersonId",
5    "name": "fee reversal",
6    "parentTopicId": "testParentTopicId",
7    "processName": "Card Fee Reversal",
8    "processType": "Flow",
9    "processStatus": "Completed",
10    "interactionSummary": "Summary",
11    "processFailureReason": "unknown",
12    "customFieldsList": [
13      {
14        "key": "sampleCheckbox__c",
15        "value": true
16      },
17      {
18        "key": "sampleDate__c",
19        "value": "06/17/2022"
20      },
21      {
22        "key": "sampleDateTime__c",
23        "value": "2022-04-17T12:00:00.000Z"
24      },
25      {
26        "key": "sampleEmail__c",
27        "value": "sample@email.com"
28      },
29      {
30        "key": "sampleLocation__c",
31        "value": {
32          "latitude": 12,
33          "longitude": 17
34        }
35      },
36      {
37        "key": "sampleNumber__c",
38        "value": 1706
39      },
40      {
41        "key": "samplePercentage__c",
42        "value": 17
43      },
44      {
45        "key": "samplePhoneNumber__c",
46        "value": "1234567890"
47      }
48    ]
49  }
50}

Properties

Name	Type	Description	Required or Optional	Available Version
`customFieldsList`	Engagement Custom Fields Input[]	The custom fields and their values for engagement topics.	Optional	56.0
`engagementInteractionId`	String	The ID of the engagement interaction record associated with an engagement topic record.	Required	55.0
`id`	String	The ID of an engagement topic record.	Required	55.0
`interactionSummary`	String	The summary of the engagement interaction.	Optional	55.0
`name`	String	The name of the engagement topic record.	Required	55.0
`ownerId`	String	The Salesforce ID of the person who owns this engagement topic record.	Required	55.0
`parentTopicId`	String	The parent engagement topic record that’s associated with this engagement topic.	Optional	55.0
`processFailureReason`	String	The reason a process failed during an engagement interaction.	Optional	55.0
`processName`	String	The name of the process executed during an engagement interaction.	Optional	55.0
`processStatus`	String	The current status of a process that’s executed during the engagement interaction. Possible values are: `Canceled` `Completed` `Failed` `Initiated`	Optional	55.0
`processType`	String	The type of the process executed during the engagement interaction.	Optional	55.0
`relatedPersonId`	String	The person for whom an engagement interaction was initiated.	Optional	55.0
`topicId`	String	The engagement topic record that’s associated with the parent engagement topic.	Optional	55.0