Newer Version Available

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

Submit for Approval Actions

Submit a Salesforce record for approval if an approval process is defined for the current entity.

For more information about creating submit for approval actions, see Creating Approval Actions, and to learn more about approval processes, see Approval Process Overview, in the Salesforce online help.

This object is available in API version 32.0 and later.

Supported REST HTTP Methods

URI
Get a list of actions:
/vXX.X/actions/standard/submit
Formats
JSON, XML
HTTP Methods
GET, HEAD, POST
Authentication
Authorization: Bearer token

Inputs

Input Details
comment
Type
string
Description
Optional. Comments that accompany the Approval submission.
nextApproverIds
Type
reference
Description
Optional. An array of one ID of the next approver, which can be a user or a group. This input is optional because some approval processes have the next approver specified in the approval process definition. You can’t specify more than 2,000 approvers.
objectId
Type
reference
Description
Required. The ID of the record being submitted for approval.
processDefinitionNameOrId
Type
string
Description
Optional. The ID or name of the approval process to run against the record. If none is specified, the first approval process whose entry criteria the record satisfies is used. Names can’t be longer than 120 characters.
skipEntryCriteria
Type
boolean
Description
Optional. A Boolean value controlling whether the entry criteria for the specified approval process should be evaluated for the record (true) or not (false). If set to true, also specify processDefinitionNameOrId.
submitterId
Type
string
Description
Optional. The ID of the user submitting the record for approval. If none is specified, the submitter is the current user.

Outputs

Output Details
actorIds
Type
reference
Description
An array of the IDs of the next approvers.
entityId
Type
reference
Description
The ID of the record submitted for approval.
instanceId
Type
reference
Description
The ID of the approval process instance.
instanceStatus
Type
string
Description
The status of the approval. The valid values are
  • Approved
  • Pending
  • Rejected
  • Removed
newWorkItemIds
Type
reference
Description
An array of the IDs of the work items created for the next step in this approval process.