Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Create a Customer Merge

Creates a customer merge specifying a source and target set of customer IDs. The merge will use the following rules:

  • Union / Merge the following fields:
    • Emails, Phones
    • Socials
    • Locations
    • Watchers
    • Custom - target takes precedence with same attribute names
    • Tags
    • KlassNames
    • conversationCounts - Sum all values
  • Chosen based on most recent:
    • Preview - Based on preview.previewAt
    • LastMessageIn - Based on lastMessageIn.sentAt
    • lastConversation - Based on lastMessageIn.sentAt
    • recentLocation - Based on recentLocation.updatedAt
    • signedUpAt
    • modifiedAt / modifiedBy
    • lastSeenAt
    • lastActivityAt
  • Chosen based on oldest:
    • createdAt / createdBy
  • Target takes precedence
    • Company
    • name,
    • externalId,
    • username,
    • avatarUrl,
    • locale,
    • timeZone,
    • birthdayAt,
    • gender

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.customer.write|org.permission.customer_merge.create| |org.admin.customer.merge.write|

Input

type: object properties: data: type: string example: '"{\n \"source\": \"<object-id>\",\n \"target\": \"<object-id>\"\n}"' title: Data

Output

type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: status: type: string createdAt: type: string updatedAt: type: string relationships: type: object properties: org: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string source: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string target: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string createdBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string