Chatter REST API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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.

Action Links are currently available to select customers through a pilot program. To be nominated to join this pilot program, contact salesforce.com. Additional terms and conditions may apply to participate in the pilot program. Please note that pilot programs are subject to change, and as such, we cannot guarantee acceptance into this pilot program or a particular time frame in which this feature can be enabled. Any unreleased services or features referenced in this document, press releases, or public statements are not currently available and may not be delivered on time or at all. Customers who purchase our services should make their purchase decisions based upon features that are currently available.

Note

Property Name Type Description Filter Group and Version Available Version
actionUrl String The action link URL. For example, for a Ui action link, the URL may be a Web page. For a Download action link, the URL is a link to the file to download. Ui and Download action link URLs are provided to clients. For an Api or ApiAsync action link, the URL may be 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, 31.0 31.0
createdDate Date An ISO 8601 format date string, for example, 2011-02-25T18:24:31.000Z.. Small, 31.0 31.0
excludedUserId String ID of a single user to exclude from performing the action. Small, 31.0 31.0
groupDefault Boolean true if this action is the default or primary action link in the action link group; false otherwise. There can be only one default action link per action link group. Small, 31.0 31.0
headers Request Header[] The request headers for the Api and ApiAsync action link types. Big, 31.0 31.0
id String 18-character ID for the action link definition. Small, 31.0 31.0
labelKey String Key for the set of labels to show in the user interface. A set includes labels for these states: new, pending, success, failed. For example, if you use the Approve key, you get these labels: Approve, Pending, Approved, Failed.

See Action Links Labels.

 Small, 31.0 31.0
method String The HTTP method. One of these values:
  • Delete—Returns HTTP 204 on success. Response body is empty.
  • Get—Returns HTTP 200 on success.
  • Head—Returns HTTP 200 on success. Response body is empty.
  • Patch—Returns HTTP 200 on success or HTTP 204 if the response body is empty.
  • Post—Returns HTTP 201 on success or HTTP 204 if the response body is empty. Exceptions are the batch posting resources, which return HTTP 200 on success.
  • Put—Return HTTP 200 on success or HTTP 204 if the response body is empty.
 Medium, 31.0 31.0
modifiedDate Date ISO8601 date string, for example, 2011-02-25T18:24:31.000Z. Small, 31.0 31.0
requestBody String The request body for Api and ApiAsync action link types. Big, 31.0 31.0
requires​Confirmation Boolean true if the action results in something that should be confirmed, such as a delete; false otherwise. Small, 31.0 31.0
type String Defines the type of action link. Values are:
  • Api—The action link calls a synchronous API.
  • ApiAsync—The action link calls an asynchronous API.
  • Download—The action link downloads a file.
  • Ui—The action link takes the user to a user interface.
 Small, 31.0 31.0
userId String The ID of the user who can execute the action. If not specified or null, any user can execute the action. Small, 31.0 31.0