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 Salesforce Help.

This object is available in API version 32.0 and later.

Supported REST HTTP Methods

URI: Get a list of actions: /services/data/vXX.X/actions/standard/submit

Formats: JSON, XML

HTTP Methods: GET, HEAD, POST

Authentication: Authorization: Bearer token

Inputs

Input Type Description
comment string Optional. Comments that accompany the Approval submission.
nextApproverIds reference 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 reference Required. The ID of the record being submitted for approval.
processDefinitionNameOrId string 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 boolean Optional. A Boolean value controlling whether the entry criteria for the specified approval process must be evaluated for the record (true) or not (false). If set to true, also specify processDefinitionNameOrId.
submitterId string Optional. The ID of the user submitting the record for approval. If none is specified, the submitter is the current user.

Outputs

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