Skip to content
Lightfield Lightfield
API Reference
Merge

Merge two opportunities

client.merge.mergeOpportunities(MergeMergeOpportunitiesParams { duplicateId, primaryId, fieldResolutions, options } body, RequestOptionsoptions?): MergeMergeOpportunitiesResponse { merge, primary, summary }
POST/v1/opportunities/merge

Merges two opportunities into one. The primary opportunity retains its ID; the duplicate is soft-deleted. Both opportunities must belong to the same account.

Required scopes: opportunities:update + opportunities:delete

Rate limit category: Write

ParametersExpand Collapse
body: MergeMergeOpportunitiesParams { duplicateId, primaryId, fieldResolutions, options }
duplicateId: string

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

primaryId: string

ID of the record to keep.

fieldResolutions?: Record<string, "primary" | "duplicate" | Value { value } >

Per-field resolution overrides keyed by attribute slug.

One of the following:
"primary" | "duplicate"
"primary"
"duplicate"
Value { value }
value: string | number | boolean | 3 more | null
One of the following:
string
number
boolean
Array<string>
Address { city, country, latitude, 5 more }
city?: string | null

City name.

country?: string | null

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

latitude?: number | null

Latitude coordinate.

longitude?: number | null

Longitude coordinate.

postalCode?: string | null

Postal or ZIP code.

state?: string | null

State or province.

street?: string | null

Street address line 1.

street2?: string | null

Street address line 2.

FullName { firstName, lastName }
firstName?: string | null

The contact’s first name.

lastName?: string | null

The contact’s last name.

options?: Options
multiSelectUnion?: boolean

When true, multi-select fields are merged by union rather than primary-takes-all.

ReturnsExpand Collapse
MergeMergeOpportunitiesResponse { merge, primary, summary }
merge: Merge { id, status }
id: string

Unique identifier for the merge operation.

status: string

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

primary: Primary { id, createdAt, fields, 4 more }
id: string

Unique identifier for the entity.

createdAt: string

ISO 8601 timestamp of when the entity was created.

fields: Record<string, Fields>

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 | number | boolean | 3 more | null

The field value, or null if unset.

One of the following:
string
number
boolean
Array<string>
Address { city, country, latitude, 5 more }
city?: string | null

City name.

country?: string | null

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

latitude?: number | null

Latitude coordinate.

longitude?: number | null

Longitude coordinate.

postalCode?: string | null

Postal or ZIP code.

state?: string | null

State or province.

street?: string | null

Street address line 1.

street2?: string | null

Street address line 2.

FullName { firstName, lastName }
firstName?: string | null

The contact’s first name.

lastName?: string | null

The contact’s last name.

valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 12 more

The data type of the field.

One of the following:
"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"
"HTML"
relationships: Record<string, Relationships>

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<string>

IDs of the related entities.

updatedAt: string | null

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

externalId?: string | null

External identifier for the entity, or null if unset.

summary: Summary { fieldWriteCount, syncRepointedCount, warnings }
fieldWriteCount: number

Number of attribute fields written onto the primary record.

minimum-9007199254740991
maximum9007199254740991
syncRepointedCount: number

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

minimum-9007199254740991
maximum9007199254740991
warnings: Array<string>

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

Merge two opportunities

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const mergeMergeOpportunitiesResponse = await client.merge.mergeOpportunities({
  duplicateId: 'duplicateId',
  primaryId: 'primaryId',
});

console.log(mergeMergeOpportunitiesResponse.merge);
{
  "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"
    ]
  }
}
Returns Examples
{
  "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"
    ]
  }
}