v6
latestOpenAPI 3.1.02026-08-047720752.5 KBMerge two records
Merges two records of the same object together. Where both records have a value for the same attribute, the primary record's value takes precedence.
Merging produces a new record, so the new_record_id returned will match neither of the records supplied in the request. Both of the original records are marked as merged and can no longer be read or written.
Large merges are completed asynchronously. A 200 response means the merged record is readable immediately. A 202 response means the merge has been accepted but is still being applied, and reading the merged record will return a 404 with the merge_in_progress error code until it completes.
This endpoint is not idempotent. Because both original records are marked as merged, repeating the same request returns 404.
This endpoint is rate limited to 5 requests per second.
This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users.
Required scopes: record_permission:read-write, object_configuration:read.
Path parameters
A UUID or slug of the object both records belong to.
Request body
Example request
{
"data": {
"primary_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
"secondary_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
}
}Response
Success
Example response
{
"data": {
"new_record_id": "f528bd86-8142-4359-9a8c-b651d50a27b1"
}
}