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

Platform Action

A platform action instance with state information for the context user.
Action links are one type of platform action and are therefore represented as platform action response bodies.

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 For action links, if the subtype is Ui, this is the URL to the UI. If the subtype is Download, this is the download URL. Otherwise, this value is null.

To call an Api or an ApiAsync action link, make a PATCH request to the Action Link resource and set status to Pending.

 Medium, 31.0 31.0
apiName String The API name. This value may be null. Medium, 32.0 32.0
confirmation​Message String If this action requires a confirmation and has a status of New, this is a default localized message that should be shown to an end user prior to invoking the action. Otherwise, this is null. Medium, 31.0 31.0
executingUser User Summary User who initiated execution of the platform action. Medium, 31.0 31.0
groupDefault Boolean true if this platform action is the default or primary platform action in the platform action group; false otherwise. There can be only one default platform action per platform action group. Small, 31.0 31.0
iconUrl String The URL of the icon for the platform action. This value may be null. Medium, 32.0 32.0
id String The ID of the platform action. The 18-character ID of the action link definition. Small, 31.0 31.0
label String The localized label for this platform action. Small, 31.0 31.0
modifiedDate Date ISO8601 date string, for example, 2011-02-25T18:24:31.000Z Small, 31.0 31.0
platformAction​Group Reference A reference to the platform action group containing this platform action. Small, 31.0 31.0
status String The execution status of the platform action. Values are:
  • Failed—The action link execution failed.
  • New—The action link is ready to be executed.
  • Pending—The action link is executing.
  • Successful—The action link executed successfully.

For action links only, you can update the status by making a PATCH request to the /connect/action-links/actionLinksId resource.

 Small, 31.0 31.0
subtype String The subtype of an 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.
The subtype property is specific to action links and isn’t used at this time for other types of platform actions.		 Small, 31.0 31.0
type String The type of platform action. Values are:
  • ActionLink—An indicator on a feed element that targets an API, a Web page, or a file and is represented by a button in the Salesforce Chatter feed UI.
  • AnchorAction—A preconfigured record action (such as Map, Read News, or View Website) in the Salesforce1 action bar.
  • CustomButton—When clicked, opens a URL or a Visualforce page in a window or executes JavaScript.
  • QuickAction—An action on the Chatter publisher on the home page, on the Chatter tab, in Chatter groups, and on record detail pages. Quick actions also appear in the action bar in Salesforce1. Quick actions are called publisher actions in Salesforce Help.
  • StandardButton—A prebuilt Salesforce button such as New, Edit, and Delete.
 Small, 31.0 31.0
url String Chatter REST API resource URL for the platform action. Small, 31.0 31.0