---
title: "Merge Object Records"
method: POST
path: "/objects/{object_slug}/records/merge"
tags: ["Objects"]
---

# Merge Object Records

`POST /objects/{object_slug}/records/merge`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/objects/{object_slug}/records/merge`
- Auth: HTTP bearer

Eligible merge: resolve fields, archive the secondary (its values closed
first), repoint links and associations onto the primary, write the primary.
Needs objects:write AND objects:delete — both scope dependencies are real
parameters so each carries its own ``required_api_key_scope`` marker.
Delegates to the Studio function (same blockers, field resolution, cascade,
far-end access rule and ``records_core`` switch).

## Path parameters

- `object_slug` string, required

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- RecordMergeRequest: Merge ``secondary_record_id`` into ``primary_record_id``. The primary's graph8 identity (id, legacy_id/legacy_type) is preserved; the secondary is archived, never hard-deleted.
  - `primary_record_id` string, uuid, required
  - `secondary_record_id` string, uuid, required
  - `field_overrides` RecordMergeFieldOverride[]
    - `attribute_slug` string, required
    - `winner` 'primary' | 'secondary', required
  - `expected_primary_revision` integer, nullable
  - `expected_secondary_revision` integer, nullable

## Response `200`

Successful Response

- ApiResponseRecordMergeResponse
  - `data` RecordMergeResponse, required
    - `record` RecordResponse, required: Response for a record with its current attribute values.
      - `id` string, uuid, required
      - `object_definition_id` string, uuid, required
      - `organization_id` string, required
      - `is_archived` boolean, required
      - `revision` integer
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `values` object, required
    - `merge_history_id` string, uuid, required
    - `cascade` RecordMergeCascade, required
      - `relationships_repointed` integer, required
      - `relationships_deleted` integer, required
      - `associations_repointed` integer, required
      - `associations_deleted` integer, required
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)