REST API Developer Guide

Introduction to REST API
About REST API
Release Notes
Supported Editions and Required Permissions
REST Resources and Requests
REST API Architecture
Authorization Through External Client Apps or Connected Apps and OAuth 2.0
Headers
Assignment Rule Header
Call Options Header
Compression Headers
Conditional Request Headers
Duplicate Rule Header
Limit Info Header
MRU Header
Package Version Header
Query Options Header
Warning Header
Send REST Requests with cURL
Valid Date and DateTime Formats
Status Codes and Error Responses
API End-of-Life Policy
Quick Start
Examples
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Assignment Rule Header

The Assignment Rule header is a request header applied when creating or updating Accounts, Cases, or Leads. If enabled, the active assignment rules are used. If disabled, the active assignment rules are not applied. If a valid AssignmentRule ID is provided, the AssignmentRule is applied. If the header is not provided with a request, REST API defaults to using the active assignment rules.

This header also gets applied when making REST API calls that indirectly result in creating or updating Accounts, Cases, or Leads. For example, if you use this header with a call that updates a record, and the update executes an Apex trigger that updates a Case, the assignment rules would be applied.

Note

Header Field Name and Values

Field name: Sforce-Auto-Assign

Field values

  • TRUE. Active assignment rules are applied for created or updated Accounts, Cases, or Leads.
  • FALSE. Active assignment rules are not applied for created or updated Accounts, Cases, or Leads.
  • Valid AssignmentRule ID. The given AssignmentRule is applied for created Accounts, Cases, or Leads.

TRUE and FALSE are not case-sensitive.

If the header is not provided in the request, the default value is TRUE.

Example: Sforce-Auto-Assign: FALSE