Action Link Definition
The definition of an action link. To read this information, a request
must use the same connected app that was used
to create the action link definition.
Property Name | Type | Description | Filter Group and Version | Available Version |
---|---|---|---|---|
actionUrl | String | The action link URL. For example, a Ui action link URL is a Web page. A Download action link URL is a link to the file to download. Ui and Download action link URLs are provided to clients. An Api or ApiAsync action link URL is a REST resource. Api and ApiAsync action link URLs aren’t provided to clients. Links to Salesforce can be relative. All other links must be absolute and start with https://. | Small, 33.0 | 33.0 |
createdDate | String | ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z.. | Small, 33.0 | 33.0 |
excludedUserId | String | ID of a single user to exclude from performing the action. If you specify an excludedUserId, you can’t specify a userId. | Small, 33.0 | 33.0 |
groupDefault | Boolean | true if this action is the default action link in the action link group; false otherwise. There can be only one default action link per action link group. The default action link gets distinct styling in the Salesforce UI. | Small, 33.0 | 33.0 |
headers | Request Header[] | The request headers for the Api and ApiAsync action link types. | Big, 33.0 | 33.0 |
id | String | 18-character ID for the action link definition. | Small, 33.0 | 33.0 |
label | String |
A custom label to display on the action link button. A
label value can be set only in an
action link template.
Action links have four
statuses: NewStatus, PendingStatus, SuccessStatus, and FailedStatus.
These strings are appended to the label for each status:
An action link can use either label or labelKey to generate label names, it can’t use both. If label has a value, the value of labelKey is None. If labelKey has a value other than None, the value of label is null. |
Small, 34.0 | 34.0 |
labelKey | String | Key for the set of labels to show in the user
interface. A set includes labels for these states: NewStatus,
PendingStatus, SuccessStatus, FailedStatus. For example, if you
use the Approve key, you
get these labels: Approve, Pending, Approved, Failed. See Action Links Labels. |
Small, 33.0 | 33.0 |
method | String | The HTTP method. One of these values:
|
Medium, 33.0 | 33.0 |
modifiedDate | String | ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z. | Small, 33.0 | 33.0 |
requestBody | String | The request body for Api and ApiAsync action link types. | Big, 33.0 | 33.0 |
requiresConfirmation | Boolean | true to require the user to confirm the action; false otherwise. | Small, 33.0 | 33.0 |
templateId | String | The ID of the action link template from which to instantiate this action link. If the action link isn’t associated with a template, the value is null. | Medium, 33.0 | 33.0 |
type | String | Defines the type of action link. Values are:
|
Small, 33.0 | 33.0 |
userId | String | The ID of the user who can execute the action. If not specified or null, any user can execute the action. If you specify a userId, you can’t specify an excludedUserId. | Small, 33.0 | 33.0 |