Merge contacts
Atomically reattaches every tenant-owned reference to the primary Contact and retires the secondary under contacts:write. Repeating the completed merge may return not found; verify both Contacts before retrying.
curl --request POST \
--url https://api.getarbol.com/v1/contacts/merge \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"primaryContactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"secondaryContactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
primaryContactId: 'agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31',
secondaryContactId: 'agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31'
})
};
fetch('https://api.getarbol.com/v1/contacts/merge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.getarbol.com/v1/contacts/merge"
payload = {
"primaryContactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"secondaryContactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"createdAt": "2026-08-29T14:30:00Z",
"details": {
"addresses": [
{
"city": "<string>",
"country": "<string>",
"id": "<string>",
"isPrimary": true,
"label": "<string>",
"postalCode": "<string>",
"state": "<string>",
"street": "<string>",
"type": "<string>"
}
]
},
"familyName": "<string>",
"givenName": "<string>",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"summary": "<string>",
"updatedAt": "2026-08-29T14:30:00Z",
"facts": [
{
"confidence": 0.5,
"definition": {
"description": "<string>",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"identifier": "<string>",
"kind": "attribute",
"subjectKind": "contact",
"valueType": "option"
},
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"observedAt": "2026-08-29T14:30:00Z",
"reason": "<string>",
"recordedAt": "2026-08-29T14:30:00Z",
"setBy": "user",
"subject": {
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"type": "contact"
},
"value": {
"type": "text",
"value": "<string>"
},
"verificationStatus": "unreviewed"
}
],
"identities": [
{
"address": "<string>",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"isPrimary": true,
"kind": "phone",
"label": "<string>",
"verified": true
}
]
}{
"defined": true,
"inferable": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "<string>",
"data": {
"issues": [
{
"code": "custom",
"message": "<string>",
"path": [
"<string>"
]
}
],
"truncated": true
}
}{
"defined": true,
"inferable": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "FORBIDDEN",
"status": 403,
"message": "<string>",
"data": {
"missingPermissions": [
"agents:read"
]
}
}{
"defined": true,
"inferable": true,
"code": "NOT_FOUND",
"status": 404,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "CONFLICT",
"status": 409,
"message": "<string>",
"data": {
"reason": "document_identity_in_use",
"path": [
"<string>"
]
}
}{
"code": "PAYLOAD_TOO_LARGE",
"defined": false,
"inferable": false,
"message": "<string>",
"data": "<unknown>"
}{
"code": "UNSUPPORTED_MEDIA_TYPE",
"defined": false,
"inferable": false,
"message": "<string>",
"data": "<unknown>"
}Authorizations
Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.
Body
Two distinct tenant-owned Contacts; all references move to the primary Contact.
Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
64^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
64^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
Response
OK
ISO 8601 timestamp with an explicit UTC offset.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$"2026-08-29T14:30:00Z"
Show child attributes
Show child attributes
160160Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
64^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
4000ISO 8601 timestamp with an explicit UTC offset.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$"2026-08-29T14:30:00Z"
100Show child attributes
Show child attributes
12Show child attributes
Show child attributes
curl --request POST \
--url https://api.getarbol.com/v1/contacts/merge \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"primaryContactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"secondaryContactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
primaryContactId: 'agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31',
secondaryContactId: 'agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31'
})
};
fetch('https://api.getarbol.com/v1/contacts/merge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.getarbol.com/v1/contacts/merge"
payload = {
"primaryContactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"secondaryContactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"createdAt": "2026-08-29T14:30:00Z",
"details": {
"addresses": [
{
"city": "<string>",
"country": "<string>",
"id": "<string>",
"isPrimary": true,
"label": "<string>",
"postalCode": "<string>",
"state": "<string>",
"street": "<string>",
"type": "<string>"
}
]
},
"familyName": "<string>",
"givenName": "<string>",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"summary": "<string>",
"updatedAt": "2026-08-29T14:30:00Z",
"facts": [
{
"confidence": 0.5,
"definition": {
"description": "<string>",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"identifier": "<string>",
"kind": "attribute",
"subjectKind": "contact",
"valueType": "option"
},
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"observedAt": "2026-08-29T14:30:00Z",
"reason": "<string>",
"recordedAt": "2026-08-29T14:30:00Z",
"setBy": "user",
"subject": {
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"type": "contact"
},
"value": {
"type": "text",
"value": "<string>"
},
"verificationStatus": "unreviewed"
}
],
"identities": [
{
"address": "<string>",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"isPrimary": true,
"kind": "phone",
"label": "<string>",
"verified": true
}
]
}{
"defined": true,
"inferable": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "<string>",
"data": {
"issues": [
{
"code": "custom",
"message": "<string>",
"path": [
"<string>"
]
}
],
"truncated": true
}
}{
"defined": true,
"inferable": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "FORBIDDEN",
"status": 403,
"message": "<string>",
"data": {
"missingPermissions": [
"agents:read"
]
}
}{
"defined": true,
"inferable": true,
"code": "NOT_FOUND",
"status": 404,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "CONFLICT",
"status": 409,
"message": "<string>",
"data": {
"reason": "document_identity_in_use",
"path": [
"<string>"
]
}
}{
"code": "PAYLOAD_TOO_LARGE",
"defined": false,
"inferable": false,
"message": "<string>",
"data": "<unknown>"
}{
"code": "UNSUPPORTED_MEDIA_TYPE",
"defined": false,
"inferable": false,
"message": "<string>",
"data": "<unknown>"
}