Skip to content
Lightfield Lightfield
API Reference

Merge

Merge operations combine two records into one.

Merge two accounts
merge.merge_accounts(MergeMergeAccountsParams**kwargs) -> MergeMergeAccountsResponse
POST/v1/accounts/merge
Merge two contacts
merge.merge_contacts(MergeMergeContactsParams**kwargs) -> MergeMergeContactsResponse
POST/v1/contacts/merge
Merge two opportunities
merge.merge_opportunities(MergeMergeOpportunitiesParams**kwargs) -> MergeMergeOpportunitiesResponse
POST/v1/opportunities/merge
Merge two custom object records
merge.merge_object_values(strentity_slug, MergeMergeObjectValuesParams**kwargs) -> MergeMergeObjectValuesResponse
POST/v1/objects/{entitySlug}/merge
Get merge status
merge.get_merge(strid) -> MergeGetMergeResponse
GET/v1/merges/{id}
ModelsExpand Collapse
class MergeGetMergeResponse: …
id: str

Unique identifier for the merge operation.

created_at: str

ISO 8601 timestamp of when the merge was created.

duplicate_id: str

ID of the record that was merged into the primary and soft-deleted.

entity_type: str

The object type of the merged records (e.g. account, contact, opportunity, or a custom object slug).

primary_id: str

ID of the record that was kept (the primary).

status: str

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

updated_at: str

ISO 8601 timestamp of when the merge was last updated.

class MergeMergeAccountsResponse: …
merge: Merge
id: str

Unique identifier for the merge operation.

status: str

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

primary: Primary
id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, PrimaryFields]

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

value: Optional[PrimaryFieldsValue]

The field value, or null if unset.

One of the following:
str
float
bool
List[str]
class PrimaryFieldsValueAddress: …
city: Optional[str]

City name.

country: Optional[str]

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

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class PrimaryFieldsValueFullName: …
first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["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: Dict[str, PrimaryRelationships]

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

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

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

values: List[str]

IDs of the related entities.

updated_at: Optional[str]

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

external_id: Optional[str]

External identifier for the entity, or null if unset.

summary: Summary
field_write_count: int

Number of attribute fields written onto the primary record.

minimum-9007199254740991
maximum9007199254740991
sync_repointed_count: int

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

minimum-9007199254740991
maximum9007199254740991
warnings: List[str]

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

class MergeMergeContactsResponse: …
merge: Merge
id: str

Unique identifier for the merge operation.

status: str

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

primary: Primary
id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, PrimaryFields]

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

value: Optional[PrimaryFieldsValue]

The field value, or null if unset.

One of the following:
str
float
bool
List[str]
class PrimaryFieldsValueAddress: …
city: Optional[str]

City name.

country: Optional[str]

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

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class PrimaryFieldsValueFullName: …
first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["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: Dict[str, PrimaryRelationships]

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

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

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

values: List[str]

IDs of the related entities.

updated_at: Optional[str]

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

external_id: Optional[str]

External identifier for the entity, or null if unset.

summary: Summary
field_write_count: int

Number of attribute fields written onto the primary record.

minimum-9007199254740991
maximum9007199254740991
sync_repointed_count: int

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

minimum-9007199254740991
maximum9007199254740991
warnings: List[str]

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

class MergeMergeObjectValuesResponse: …
merge: Merge
id: str

Unique identifier for the merge operation.

status: str

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

primary: Primary
id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, PrimaryFields]

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

value: Optional[PrimaryFieldsValue]

The field value, or null if unset.

One of the following:
str
float
bool
List[str]
class PrimaryFieldsValueAddress: …
city: Optional[str]

City name.

country: Optional[str]

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

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class PrimaryFieldsValueFullName: …
first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["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: Dict[str, PrimaryRelationships]

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

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

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

values: List[str]

IDs of the related entities.

updated_at: Optional[str]

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

external_id: Optional[str]

External identifier for the entity, or null if unset.

summary: Summary
field_write_count: int

Number of attribute fields written onto the primary record.

minimum-9007199254740991
maximum9007199254740991
sync_repointed_count: int

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

minimum-9007199254740991
maximum9007199254740991
warnings: List[str]

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

class MergeMergeOpportunitiesResponse: …
merge: Merge
id: str

Unique identifier for the merge operation.

status: str

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

primary: Primary
id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, PrimaryFields]

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

value: Optional[PrimaryFieldsValue]

The field value, or null if unset.

One of the following:
str
float
bool
List[str]
class PrimaryFieldsValueAddress: …
city: Optional[str]

City name.

country: Optional[str]

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

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class PrimaryFieldsValueFullName: …
first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["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: Dict[str, PrimaryRelationships]

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

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

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

values: List[str]

IDs of the related entities.

updated_at: Optional[str]

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

external_id: Optional[str]

External identifier for the entity, or null if unset.

summary: Summary
field_write_count: int

Number of attribute fields written onto the primary record.

minimum-9007199254740991
maximum9007199254740991
sync_repointed_count: int

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

minimum-9007199254740991
maximum9007199254740991
warnings: List[str]

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