SObject Rows by External ID

Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.

• If the specified value doesn't exist, a new record is created.
• If a record does exist with that value, the field values specified in the request body are updated.
• If the value is not unique, the REST API returns a 300 response with the list of matching records.

URI

/vXX.X/sobjects/SObjectName/fieldName/fieldValue

Formats

JSON, XML

HTTP Method

HEAD, GET, PATCH, DELETE

Authentication

Authorization: Bearer token

Parameters

None

Examples

• For an example of retrieving a record based on an external ID, see Retrieve a Record Using an External ID.
• For examples of creating and updating records based on external IDs, see Insert or Update (Upsert) a Record Using an External ID.