Actionable List Definition (PATCH)

Partially update an existing actionable list definition. Only the fields in the request body are updated. Omitted fields are unchanged. Array fields represent the desired state.

Resource

1/connect/actionable-list-definitions/ACTIONABLE_LIST_DEFINITION_ID

Available Version

68.0

HTTP Methods

PATCH

URI Parameters

Parameter Name	Type	Description	Required
`actionableListDefinitionId`	String	ID of the actionable list definition to update.	Required

Request Body for PATCH

JSON Example

1{
2  "description": "Actionable list description",
3  "memberStatuses": [
4    {
5      "status": "New",
6      "iconName": "standard:new"
7    }
8  ],
9  "actionableListFields": [
10    "Account.Name",
11    "Account.BillingCity",
12    "Account.Industry",
13    "Account.AnnualRevenue"
14  ],
15  "sourceColumns": [
16    {
17      "sourceColumnApiName": "City__c",
18      "isTypeAheadSearchEnabled": true
19    },
20    {
21      "sourceColumnApiName": "Industry__c",
22      "isTypeAheadSearchEnabled": true
23    },
24    {
25      "sourceColumnApiName": "AnnualRevenue__c",
26      "isTypeAheadSearchEnabled": false
27    }
28  ]
29}

Properties

Property Name	Type	Description	Required
`description`	String	Description of the actionable list definition. The maximum length is 1,000 characters. Pass null to clear the description.	Optional
`sourceColumns`	Actionable List Definition Source Column Input[]	Source column configurations for filtering and picklists. The array represents the desired state. An empty array removes all source columns. Source columns are supported only for Data Cloud data model object definitions. See Actionable List Definition Source Column Input.	Optional
`actionableListFields`	String[]	Fields to display in the actionable list view. The array represents the desired state. You can have a maximum of 20 display columns per definition.	Optional
`memberStatuses`	Actionable List Definitions Member Status Input[]	Member statuses associated with this actionable list definition. The array represents the desired state. See Actionable List Definitions Member Status Input.	Optional

Response Body for PATCH

Actionable List Definition Update