Merge two accounts

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

POST/v1/accounts/merge

Merges two accounts into one. The primary account retains its ID; the duplicate is soft-deleted.

Required scopes: accounts:update + accounts:delete

Rate limit category: Write

ParametersExpand Collapse

body MergeMergeAccountsParams

DuplicateID param.Field[string]

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

PrimaryID param.Field[string]

ID of the record to keep.

FieldResolutions param.Field[map[string, MergeMergeAccountsParamsFieldResolutionUnion]]Optional

Per-field resolution overrides keyed by attribute slug.

type MergeMergeAccountsParamsFieldResolutionString string

One of the following:

const MergeMergeAccountsParamsFieldResolutionStringPrimary MergeMergeAccountsParamsFieldResolutionString = "primary"

const MergeMergeAccountsParamsFieldResolutionStringDuplicate MergeMergeAccountsParamsFieldResolutionString = "duplicate"

type MergeMergeAccountsParamsFieldResolutionValue struct{…}

Value MergeMergeAccountsParamsFieldResolutionValueValueUnion

One of the following:

string

float64

bool

type MergeMergeAccountsParamsFieldResolutionValueValueArray []string

type MergeMergeAccountsParamsFieldResolutionValueValueAddress 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 MergeMergeAccountsParamsFieldResolutionValueValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

Options param.Field[MergeMergeAccountsParamsOptions]Optional

MultiSelectUnion boolOptional

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

ReturnsExpand Collapse

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).

Merge two accounts

package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  mergeMergeAccountsResponse, err := client.Merge.MergeAccounts(context.TODO(), githubcomlightfldlightfieldgo.MergeMergeAccountsParams{
    DuplicateID: "duplicateId",
    PrimaryID: "primaryId",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", mergeMergeAccountsResponse.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"
    ]
  }
}