Skip to main content
POST
/
contacts
/
merge
Merge contacts
curl --request POST \
  --url https://api.getarbol.com/v1/contacts/merge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "primaryContactId": "<string>",
  "secondaryContactId": "<string>"
}
'
{
  "id": "<string>",
  "givenName": "<string>",
  "familyName": "<string>",
  "displayName": "<string>",
  "contactPoints": [
    {
      "id": "<string>",
      "type": "EMAIL",
      "value": "<string>",
      "label": "<string>",
      "isPrimary": true,
      "isVerified": true
    }
  ],
  "addresses": [
    {
      "id": "<string>",
      "type": "HOME",
      "streetAddress": "<string>",
      "addressLocality": "<string>",
      "addressRegion": "<string>",
      "postalCode": "<string>",
      "addressCountry": "<string>",
      "isPrimary": true
    }
  ],
  "aiSummary": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.

Body

application/json
primaryContactId
string
required

ID of the contact to keep

secondaryContactId
string
required

ID of the contact to merge into the primary

Response

Merged contact

id
string
givenName
string
familyName
string
displayName
string
contactPoints
object[]
addresses
object[]
aiSummary
string | null
metadata
object
createdAt
string<date-time>
updatedAt
string<date-time>