Merge

Merge operations combine two records into one.

Merge two accounts

client.Merge.MergeAccounts(ctx, body) (*MergeMergeAccountsResponse, error)

POST/v1/accounts/merge

Merge two contacts

client.Merge.MergeContacts(ctx, body) (*MergeMergeContactsResponse, error)

POST/v1/contacts/merge

Merge two opportunities

client.Merge.MergeOpportunities(ctx, body) (*MergeMergeOpportunitiesResponse, error)

POST/v1/opportunities/merge

Merge two custom object records

client.Merge.MergeObjectValues(ctx, entitySlug, body) (*MergeMergeObjectValuesResponse, error)

POST/v1/objects/{entitySlug}/merge

Get merge status

client.Merge.GetMerge(ctx, id) (*MergeGetMergeResponse, error)

GET/v1/merges/{id}

ModelsExpand Collapse

type MergeGetMergeResponse struct{…}

ID string

Unique identifier for the merge operation.

CreatedAt string

ISO 8601 timestamp of when the merge was created.

DuplicateID string

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

EntityType string

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

PrimaryID string

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

Status string

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

UpdatedAt string

ISO 8601 timestamp of when the merge was last updated.

type MergeMergeAccountsResponse struct{…}

Merge MergeMergeAccountsResponseMerge

ID string

Unique identifier for the merge operation.

Status string

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

Primary MergeMergeAccountsResponsePrimary

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, MergeMergeAccountsResponsePrimaryField]

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

Value MergeMergeAccountsResponsePrimaryFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type MergeMergeAccountsResponsePrimaryFieldValueArray []string

type MergeMergeAccountsResponsePrimaryFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

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

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type MergeMergeAccountsResponsePrimaryFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const MergeMergeAccountsResponsePrimaryFieldValueTypeAddress MergeMergeAccountsResponsePrimaryFieldValueType = "ADDRESS"

const MergeMergeAccountsResponsePrimaryFieldValueTypeCheckbox MergeMergeAccountsResponsePrimaryFieldValueType = "CHECKBOX"

const MergeMergeAccountsResponsePrimaryFieldValueTypeCurrency MergeMergeAccountsResponsePrimaryFieldValueType = "CURRENCY"

const MergeMergeAccountsResponsePrimaryFieldValueTypeDatetime MergeMergeAccountsResponsePrimaryFieldValueType = "DATETIME"

const MergeMergeAccountsResponsePrimaryFieldValueTypeEmail MergeMergeAccountsResponsePrimaryFieldValueType = "EMAIL"

const MergeMergeAccountsResponsePrimaryFieldValueTypeFullName MergeMergeAccountsResponsePrimaryFieldValueType = "FULL_NAME"

const MergeMergeAccountsResponsePrimaryFieldValueTypeMarkdown MergeMergeAccountsResponsePrimaryFieldValueType = "MARKDOWN"

const MergeMergeAccountsResponsePrimaryFieldValueTypeMultiSelect MergeMergeAccountsResponsePrimaryFieldValueType = "MULTI_SELECT"

const MergeMergeAccountsResponsePrimaryFieldValueTypeNumber MergeMergeAccountsResponsePrimaryFieldValueType = "NUMBER"

const MergeMergeAccountsResponsePrimaryFieldValueTypeSingleSelect MergeMergeAccountsResponsePrimaryFieldValueType = "SINGLE_SELECT"

const MergeMergeAccountsResponsePrimaryFieldValueTypeSocialHandle MergeMergeAccountsResponsePrimaryFieldValueType = "SOCIAL_HANDLE"

const MergeMergeAccountsResponsePrimaryFieldValueTypeTelephone MergeMergeAccountsResponsePrimaryFieldValueType = "TELEPHONE"

const MergeMergeAccountsResponsePrimaryFieldValueTypeText MergeMergeAccountsResponsePrimaryFieldValueType = "TEXT"

const MergeMergeAccountsResponsePrimaryFieldValueTypeURL MergeMergeAccountsResponsePrimaryFieldValueType = "URL"

const MergeMergeAccountsResponsePrimaryFieldValueTypeHTML MergeMergeAccountsResponsePrimaryFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, MergeMergeAccountsResponsePrimaryRelationship]

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

IDs of the related entities.

UpdatedAt string

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

ExternalID stringOptional

External identifier for the entity, or null if unset.

Summary MergeMergeAccountsResponseSummary

FieldWriteCount int64

Number of attribute fields written onto the primary record.

minimum-9007199254740991

maximum9007199254740991

SyncRepointedCount int64

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

minimum-9007199254740991

maximum9007199254740991

Warnings []string

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

type MergeMergeContactsResponse struct{…}

Merge MergeMergeContactsResponseMerge

ID string

Unique identifier for the merge operation.

Status string

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

Primary MergeMergeContactsResponsePrimary

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, MergeMergeContactsResponsePrimaryField]

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

Value MergeMergeContactsResponsePrimaryFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type MergeMergeContactsResponsePrimaryFieldValueArray []string

type MergeMergeContactsResponsePrimaryFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

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

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type MergeMergeContactsResponsePrimaryFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const MergeMergeContactsResponsePrimaryFieldValueTypeAddress MergeMergeContactsResponsePrimaryFieldValueType = "ADDRESS"

const MergeMergeContactsResponsePrimaryFieldValueTypeCheckbox MergeMergeContactsResponsePrimaryFieldValueType = "CHECKBOX"

const MergeMergeContactsResponsePrimaryFieldValueTypeCurrency MergeMergeContactsResponsePrimaryFieldValueType = "CURRENCY"

const MergeMergeContactsResponsePrimaryFieldValueTypeDatetime MergeMergeContactsResponsePrimaryFieldValueType = "DATETIME"

const MergeMergeContactsResponsePrimaryFieldValueTypeEmail MergeMergeContactsResponsePrimaryFieldValueType = "EMAIL"

const MergeMergeContactsResponsePrimaryFieldValueTypeFullName MergeMergeContactsResponsePrimaryFieldValueType = "FULL_NAME"

const MergeMergeContactsResponsePrimaryFieldValueTypeMarkdown MergeMergeContactsResponsePrimaryFieldValueType = "MARKDOWN"

const MergeMergeContactsResponsePrimaryFieldValueTypeMultiSelect MergeMergeContactsResponsePrimaryFieldValueType = "MULTI_SELECT"

const MergeMergeContactsResponsePrimaryFieldValueTypeNumber MergeMergeContactsResponsePrimaryFieldValueType = "NUMBER"

const MergeMergeContactsResponsePrimaryFieldValueTypeSingleSelect MergeMergeContactsResponsePrimaryFieldValueType = "SINGLE_SELECT"

const MergeMergeContactsResponsePrimaryFieldValueTypeSocialHandle MergeMergeContactsResponsePrimaryFieldValueType = "SOCIAL_HANDLE"

const MergeMergeContactsResponsePrimaryFieldValueTypeTelephone MergeMergeContactsResponsePrimaryFieldValueType = "TELEPHONE"

const MergeMergeContactsResponsePrimaryFieldValueTypeText MergeMergeContactsResponsePrimaryFieldValueType = "TEXT"

const MergeMergeContactsResponsePrimaryFieldValueTypeURL MergeMergeContactsResponsePrimaryFieldValueType = "URL"

const MergeMergeContactsResponsePrimaryFieldValueTypeHTML MergeMergeContactsResponsePrimaryFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, MergeMergeContactsResponsePrimaryRelationship]

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

IDs of the related entities.

UpdatedAt string

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

ExternalID stringOptional

External identifier for the entity, or null if unset.

Summary MergeMergeContactsResponseSummary

FieldWriteCount int64

Number of attribute fields written onto the primary record.

minimum-9007199254740991

maximum9007199254740991

SyncRepointedCount int64

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

minimum-9007199254740991

maximum9007199254740991

Warnings []string

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

type MergeMergeObjectValuesResponse struct{…}

Merge MergeMergeObjectValuesResponseMerge

ID string

Unique identifier for the merge operation.

Status string

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

Primary MergeMergeObjectValuesResponsePrimary

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, MergeMergeObjectValuesResponsePrimaryField]

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

Value MergeMergeObjectValuesResponsePrimaryFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type MergeMergeObjectValuesResponsePrimaryFieldValueArray []string

type MergeMergeObjectValuesResponsePrimaryFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

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

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type MergeMergeObjectValuesResponsePrimaryFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeAddress MergeMergeObjectValuesResponsePrimaryFieldValueType = "ADDRESS"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeCheckbox MergeMergeObjectValuesResponsePrimaryFieldValueType = "CHECKBOX"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeCurrency MergeMergeObjectValuesResponsePrimaryFieldValueType = "CURRENCY"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeDatetime MergeMergeObjectValuesResponsePrimaryFieldValueType = "DATETIME"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeEmail MergeMergeObjectValuesResponsePrimaryFieldValueType = "EMAIL"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeFullName MergeMergeObjectValuesResponsePrimaryFieldValueType = "FULL_NAME"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeMarkdown MergeMergeObjectValuesResponsePrimaryFieldValueType = "MARKDOWN"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeMultiSelect MergeMergeObjectValuesResponsePrimaryFieldValueType = "MULTI_SELECT"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeNumber MergeMergeObjectValuesResponsePrimaryFieldValueType = "NUMBER"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeSingleSelect MergeMergeObjectValuesResponsePrimaryFieldValueType = "SINGLE_SELECT"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeSocialHandle MergeMergeObjectValuesResponsePrimaryFieldValueType = "SOCIAL_HANDLE"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeTelephone MergeMergeObjectValuesResponsePrimaryFieldValueType = "TELEPHONE"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeText MergeMergeObjectValuesResponsePrimaryFieldValueType = "TEXT"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeURL MergeMergeObjectValuesResponsePrimaryFieldValueType = "URL"

const MergeMergeObjectValuesResponsePrimaryFieldValueTypeHTML MergeMergeObjectValuesResponsePrimaryFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, MergeMergeObjectValuesResponsePrimaryRelationship]

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

IDs of the related entities.

UpdatedAt string

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

ExternalID stringOptional

External identifier for the entity, or null if unset.

Summary MergeMergeObjectValuesResponseSummary

FieldWriteCount int64

Number of attribute fields written onto the primary record.

minimum-9007199254740991

maximum9007199254740991

SyncRepointedCount int64

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

minimum-9007199254740991

maximum9007199254740991

Warnings []string

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

type MergeMergeOpportunitiesResponse struct{…}

Merge MergeMergeOpportunitiesResponseMerge

ID string

Unique identifier for the merge operation.

Status string

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

Primary MergeMergeOpportunitiesResponsePrimary

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, MergeMergeOpportunitiesResponsePrimaryField]

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

Value MergeMergeOpportunitiesResponsePrimaryFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type MergeMergeOpportunitiesResponsePrimaryFieldValueArray []string

type MergeMergeOpportunitiesResponsePrimaryFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

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

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type MergeMergeOpportunitiesResponsePrimaryFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeAddress MergeMergeOpportunitiesResponsePrimaryFieldValueType = "ADDRESS"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeCheckbox MergeMergeOpportunitiesResponsePrimaryFieldValueType = "CHECKBOX"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeCurrency MergeMergeOpportunitiesResponsePrimaryFieldValueType = "CURRENCY"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeDatetime MergeMergeOpportunitiesResponsePrimaryFieldValueType = "DATETIME"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeEmail MergeMergeOpportunitiesResponsePrimaryFieldValueType = "EMAIL"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeFullName MergeMergeOpportunitiesResponsePrimaryFieldValueType = "FULL_NAME"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeMarkdown MergeMergeOpportunitiesResponsePrimaryFieldValueType = "MARKDOWN"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeMultiSelect MergeMergeOpportunitiesResponsePrimaryFieldValueType = "MULTI_SELECT"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeNumber MergeMergeOpportunitiesResponsePrimaryFieldValueType = "NUMBER"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeSingleSelect MergeMergeOpportunitiesResponsePrimaryFieldValueType = "SINGLE_SELECT"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeSocialHandle MergeMergeOpportunitiesResponsePrimaryFieldValueType = "SOCIAL_HANDLE"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeTelephone MergeMergeOpportunitiesResponsePrimaryFieldValueType = "TELEPHONE"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeText MergeMergeOpportunitiesResponsePrimaryFieldValueType = "TEXT"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeURL MergeMergeOpportunitiesResponsePrimaryFieldValueType = "URL"

const MergeMergeOpportunitiesResponsePrimaryFieldValueTypeHTML MergeMergeOpportunitiesResponsePrimaryFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, MergeMergeOpportunitiesResponsePrimaryRelationship]

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

IDs of the related entities.

UpdatedAt string

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

ExternalID stringOptional

External identifier for the entity, or null if unset.

Summary MergeMergeOpportunitiesResponseSummary

FieldWriteCount int64

Number of attribute fields written onto the primary record.

minimum-9007199254740991

maximum9007199254740991

SyncRepointedCount int64

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

minimum-9007199254740991

maximum9007199254740991

Warnings []string

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