Action Link Group Definition Input

Information in the action link definition can be sensitive to a third party (for example, OAuth bearer token headers). For this reason, only requests made via the client app that created the action link definition can read, modify, or delete the definition. In addition, the user making the request must have created the definition or have View All Data permission.

Root XML tag

<actionLinkGroup>

JSON example

This example instantiates an action link group definition without a template:

1{
2  "actionLinks": [
3  {
4    "actionType": "Api",
5    "labelKey": "Like",
6    "groupDefault": "true",
7    "actionUrl": "https://test.com/this",
8    "method": "HttpPost",
9    "requiresConfirmation": "false"
10  },
11  {
12    "actionType": "Api",
13    "labelKey": "Unlike",
14    "groupDefault": "false",
15    "actionUrl": "https://test.com/that",
16    "method": "HttpPost",
17    "requiresConfirmation": "false"
18  }
19  ],
20  "executionsAllowed": "OncePerUser",
21  "expirationDate": "2014-07-07T23:59:11.168Z",
22  "category": "Primary"
23}

This example instantiates an action link group definition from a template:

1{
2   "templateId":"07gD00000004C9r",
3   "templateBindings":[
4      {
5         "key":"Bindings.version",
6         "value":"v33.0"
7      }
8   ]
9}

Properties

Name	Type	Description	Required or Optional	Available Version
actionLinks	Action Link Definition Input[]	The action links in the group. Within an action link group, action links are displayed in the order listed in the actionLinks property of the Action Link Group Definition Input request body. Within a feed item, action link groups are displayed in the order specified in the actionLinkGroupIds property of the Associated Actions Capability Input request body.	Required to instantiate this action link group without a template. To instantiate from a template, don’t specify a value.	33.0
category	String	Indicates the priority and relative locations of action links in an associated feed item. Values are: Primary—The action link group is displayed in the body of the feed element. Overflow—The action link group is displayed in the overflow menu of the feed element. You can create up to three action links in a Primary group and up to four in an Overflow group.	Required to instantiate this action link group without a template. To instantiate from a template, don’t specify a value.	33.0
executionsAllowed	String	Defines the number of times an action link can be executed. Values are: Once—An action link can be executed only one time across all users. OncePerUser—An action link can be executed only one time for each user. Unlimited—An action link can be executed an unlimited number of times by each user. If the action link’s actionType is Api or ApiAsync, you can’t use this value.	Required to instantiate this action link group without a template. To instantiate from a template, don’t specify a value.	33.0
expirationDate	String	ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, that represents the date and time this action link group is removed from associated feed items and can no longer be executed. The expirationDate must be within one year of the creation date. If the action link group definition includes an OAuth token, it is a good idea to set the expiration date of the action link group to the same value as the expiration date of the OAuth token so that users can’t execute the action link and get an OAuth error. To set a date when instantiating from a template, see Set the Action Link Group Expiration Time in Design Action Link Templates.	Required to instantiate this action link group without a template. Optional to instantiate from a template.	33.0
templateBindings	Action Link Template Binding Input[]	A collection of key-value pairs to fill in binding variable values or a custom user alias from an action link template. To instantiate this action link group from an action link template that uses binding variables, you must provide values for all the variables. See Define Binding Variables in Design Action Link Templates.	To instantiate without a template, don’t specify a value. Required to instantiate this action link group from a template that uses binding variables.	33.0
templateId	String	The ID of the action link group template from which to instantiate this action link group.	To instantiate without a template, don’t specify a value. Required to instantiate this action link group from a template.	33.0