## Merge two custom object records

`$ lightfield merge merge-object-values`

**post** `/v1/objects/{entitySlug}/merge`

Merges two records of the specified custom object type into one. The primary record retains its ID; the duplicate is soft-deleted. Both records must belong to the custom object type named in the path.

**[Required scopes](/using-the-api/scopes/):** `custom_objects:update` + `custom_objects:delete`

**[Rate limit category](/using-the-api/rate-limits/):** Write

### Parameters

- `--entity-slug: string`

  The slug of the custom object type.

- `--duplicate-id: string`

  ID of the duplicate record to merge into the primary and then discard.

- `--primary-id: string`

  ID of the record to keep.

- `--field-resolutions: optional map["primary" or "duplicate" or object { value } ]`

  Per-field resolution overrides keyed by attribute slug.

- `--options: optional object { multiSelectUnion }`

### Returns

- `merge_merge_object_values_response: object { merge, primary, summary }`

  - `merge: object { id, status }`

    - `id: string`

      Unique identifier for the merge operation.

    - `status: string`

      Current status of the merge: `cleanup_pending`, `done`, or `failed`.

  - `primary: object { id, createdAt, fields, 4 more }`

    - `id: string`

      Unique identifier for the entity.

    - `createdAt: string`

      ISO 8601 timestamp of when the entity was created.

    - `fields: map[object { value, valueType } ]`

      Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.

      - `value: string or number or boolean or 3 more`

        The field value, or null if unset.

        - `union_member_0: string`

        - `union_member_1: number`

        - `union_member_2: boolean`

        - `union_member_3: array of string`

        - `Address: object { city, country, latitude, 5 more }`

          - `city: optional string`

            City name.

          - `country: optional string`

            2-letter ISO 3166-1 alpha-2 country code.

          - `latitude: optional number`

            Latitude coordinate.

          - `longitude: optional number`

            Longitude coordinate.

          - `postalCode: optional string`

            Postal or ZIP code.

          - `state: optional string`

            State or province.

          - `street: optional string`

            Street address line 1.

          - `street2: optional string`

            Street address line 2.

        - `FullName: object { firstName, lastName }`

          - `firstName: optional string`

            The contact's first name.

          - `lastName: optional string`

            The contact's last name.

      - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 12 more`

        The data type of the field.

        - `"ADDRESS"`

        - `"CHECKBOX"`

        - `"CURRENCY"`

        - `"DATETIME"`

        - `"EMAIL"`

        - `"FULL_NAME"`

        - `"MARKDOWN"`

        - `"MULTI_SELECT"`

        - `"NUMBER"`

        - `"SINGLE_SELECT"`

        - `"SOCIAL_HANDLE"`

        - `"TELEPHONE"`

        - `"TEXT"`

        - `"URL"`

        - `"HTML"`

    - `httpLink: string`

      URL to view the entity in the Lightfield web app, or null.

    - `relationships: map[object { cardinality, objectType, values } ]`

      Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

      - `cardinality: string`

        Whether the relationship is `has_one` or `has_many`.

      - `objectType: string`

        The type of the related object (e.g. `account`, `contact`).

      - `values: array of string`

        IDs of the related entities.

    - `updatedAt: string`

      ISO 8601 timestamp of when the entity was last updated, or null.

    - `externalId: optional string`

      External identifier for the entity, or null if unset.

  - `summary: object { fieldWriteCount, syncRepointedCount, warnings }`

    - `fieldWriteCount: number`

      Number of attribute fields written onto the primary record.

    - `syncRepointedCount: number`

      Number of related records re-pointed from the duplicate to the primary.

    - `warnings: array of string`

      Non-fatal warnings from the merge (e.g. skipped transfers).

### Example

```cli
lightfield merge merge-object-values \
  --api-key 'My API Key' \
  --entity-slug entitySlug \
  --duplicate-id duplicateId \
  --primary-id primaryId
```

#### Response

```json
{
  "merge": {
    "id": "id",
    "status": "status"
  },
  "primary": {
    "id": "id",
    "createdAt": "createdAt",
    "fields": {
      "foo": {
        "value": "string",
        "valueType": "ADDRESS"
      }
    },
    "httpLink": "httpLink",
    "relationships": {
      "foo": {
        "cardinality": "cardinality",
        "objectType": "objectType",
        "values": [
          "string"
        ]
      }
    },
    "updatedAt": "updatedAt",
    "externalId": "externalId"
  },
  "summary": {
    "fieldWriteCount": -9007199254740991,
    "syncRepointedCount": -9007199254740991,
    "warnings": [
      "string"
    ]
  }
}
```