Lead Action

Manage your leads by using the invocable action.

Leads must be enabled in your org. The user must have read and edit permissions for leads.

URIs

Apply Lead Assignment Rules: /services/data/vXX.X/actions/standard/invocableApplyLeadAssignmentRules

Formats: JSON, XML

HTTP Methods: GET, HEAD, POST

Authentication: Authorization: Bearer token

Other Information: Error Response Types

Run lead assignment rules on a collection of leads.

The Apply Lead Assignment Rules action can process up to 20 lead records at a time.

Available in API version 54.0.

URI: /services/data/vXX.X/actions/standard/invocableApplyLeadAssignmentRules

InputTypeDescription
LeadIdsString CollectionRequired. A collection of lead IDs to run lead assignment rules for.

Sample Input

This code runs lead assignment rules for two leads:

Sample Output

This code sample illustrates a response when the action succeeds.

Sales Engagement actions can respond with success or errors.

If any type of error occurs with an action, the isSuccess field is false.

This example illustrates an error caused when the user has insufficient access to leads when calling the Apply Lead Assignment Rules action.

This example illustrates an error caused when the lead IDs passed to the Apply Lead Assignment Rules action are invalid.

This example illustrates an error caused when one of the leads passed to the Apply Lead Assignment Rules action has been deleted.