Standard Invocable Actions

Returns the list of actions that can be statically invoked. You can also get basic information for each type of action.

This resource is available in REST API version 32.0 and later.

Syntax

URI

Get a list of standard actions:

/vXX.X/actions/standard

Formats

JSON

HTTP Methods

GET, HEAD, POST

Authentication

Authorization: Bearer token

Parameters

None

Notes

The Post to Chatter action supports the following features using a special format in the body post.

@mentions using @[<id>]
Topics using #[<topicString>]

For example, the string Hi @[005000000000001] check this out #[some_topic]. is stored appropriately as Hi @Joe, check this out #some_topic. where “@Joe” and “#some_topic” are links to the user and topic, respectively.

Examples

Retrieving a list of standard actions for the current organization

1/services/data/v32.0/actions/standard

JSON Response body

1{
2    "actions" : [ {
3    "label" : "Submit for Approval",
4    "name" : "submit",
5    "type" : "SUBMITAPPROVAL"
6  }, {
7    "label" : "Post to Chatter",
8    "name" : "chatterPost",
9    "type" : "CHATTERPOST" },
10  }, {
11    "label" : "Send Email",
12    "name" : "emailSimple",
13    "type" : "EMAILSIMPLE"
14  } ]
15}

Get the attributes of a single standard action, for example, emailSimple

/services/data/v32.0/actions/standard/emailSimple

JSON Response body

1{
2"description" : "Send an email where you specify the subject, body, and recipients.",
3"inputs" : [ {
4  "byteLength" : 0,
5  "description" : "Optional. The email recipients specified as a comma-separated list.",
6  "label" : "Email Addresses (comma-separated)",
7  "maxOccurs" : 1,
8  "name" : "emailAddresses",
9  "picklistValues" : null,
10  "required" : false,
11  "sobjectType" : null,
12  "type" : "STRING"
13}, { 
14  "byteLength" : 0,
15  "description" : "Optional. The email recipients specified as a collection of Strings.",
16  "label" : "Email Addresses (collection)",
17  "maxOccurs" : 5,
18  "name" : "emailAddressesArray",
19  "picklistValues" : null,
20  "required" : false,
21  "sobjectType" : null,
22  "type" : "STRING"
23}, {
24  "byteLength" : 0,
25  "description" : "Optional. Who the email is from. Defaults to the current user.",
26  "label" : "Sender Type",
27  "maxOccurs" : 1,
28  "name" : "senderType",
29  "picklistValues" : null,
30  "required" : false,
31  "sobjectType" : null,
32  "type" : "STRING"
33}, {
34  "byteLength" : 0,
35  "description" : "Required. The email's subject.",
36  "label" : "Subject",
37  "maxOccurs" : 1,
38  "name" : "emailSubject",
39  "picklistValues" : null,
40  "required" : true,
41  "sobjectType" : null,
42  "type" : "STRING"
43}, {
44  "byteLength" : 0,
45  "description" : "Required. The body of the email in plain text.",
46  "label" : "Body",
47  "maxOccurs" : 1,
48  "name" : "emailBody",
49  "picklistValues" : null,
50  "required" : true,
51  "sobjectType" : null,
52  "type" : "TEXTAREA"
53} ],
54  "label" : "Send Email",
55  "name" : "emailSimple",
56  "outputs" : [ ],
57  "standard" : true,
58  "targetEntityName" : null,
59  "type" : "EMAILSIMPLE"
60}

REST API Developer Guide

Standard Invocable Actions

Syntax

Examples