Actionable List Definitions (POST)

Create an actionable list definition, including source details, display fields, and member statuses.

Resource

1/connect/actionable-list-definitions

Available Version

68.0

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "apiName": "My_Actionable_List_Definition",
3  "displayName": "My Actionable List Definition",
4  "description": "Actionable List Definition description",
5  "anchorObjectName": "Account",
6  "actionableListFields": [
7    "Account.Name",
8    "Account.Id"
9  ],
10  "memberStatuses": [
11    {
12      "status": "New",
13      "iconName": "standard:new"
14    }
15  ],
16  "sourceType": "DATA_MODEL_OBJECT",
17  "sourceDetails": {
18    "objectName": "AccountDMO",
19    "anchorKeyField": "accountId",
20    "sourceColumns": [
21      {
22        "sourceColumnApiName": "City__c",
23        "isTypeAheadSearchEnabled": true
24      },
25      {
26        "sourceColumnApiName": "Industry__c",
27        "isTypeAheadSearchEnabled": true
28      },
29      {
30        "sourceColumnApiName": "AnnualRevenue__c",
31        "isTypeAheadSearchEnabled": false
32      }
33    ]
34  }
35}

Properties

Property Name	Type	Description	Required
`apiName`	String	API name of the actionable list definition.	Required
`displayName`	String	Display name for the actionable list definition.	Required
`anchorObjectName`	String	API name of the primary object that’s associated with the definition.	Required
`description`	String	Description of the actionable list definition.	Optional
`sourceType`	String	Source type to create the actionable list definition for.	Required
`actionableListFields`	String[]	List of fields to be displayed in the actionable list view.	Optional
`memberStatuses`	Actionable List Definitions Member Status Input[]	Details of the member statuses of the definition. See Actionable List Definitions Member Status Input.	Optional
`sourceDetails`	Actionable List Definitions Source Details Input	Details of the source type that’s associated with the actionable list definition. See Actionable List Definitions Source Details Input.	Optional

Response Body for POST

Actionable List Definitions Create