API v1
v1
View as Markdown

Rule a pair out

PUT /api/v1/vaults/{vault}/duplicates/{candidate}/dismissal

Say that two contacts the product proposed are two different people.

This is permanent. Detection keeps recomputing and leaves the pair alone from now on, so it is never raised again even though the two still resemble each other, which they will.

Ruling out a pair that is already ruled out answers exactly the same way and changes nothing, so calling this twice is safe.

Path parameters

Sent as JSON. Anything not listed here is ignored.

vault uuid Required

The id of the vault the contacts live in. A path that is not a uuid answers 404 without a query being run.

candidate integer Required

The id of a pair this vault proposed.

Returns

The pair as it now reads, with dismissed_at set. A pair in another vault or another account answers 404.

data object

The pair.

data.type string

Always contact_duplicate_candidate. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.

data.id string

The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.

data.attributes object

Everything the record holds.

data.attributes.contact_id string

One of the two contacts.

data.attributes.other_contact_id string

The other one.

data.attributes.contact_name string

What the first one is called, so a list reads without a second request.

data.attributes.other_contact_name string

What the second one is called.

data.attributes.score integer

How strongly the two resemble each other, 0 to 100. It orders the list and says nothing about certainty.

data.attributes.reasons array

One entry per signal that fired.

data.attributes.reasons[] object

One signal.

data.attributes.reasons[].kind string

Either name, when the two names resemble each other, or field, when the two share a value in a field the structure marks as identifying.

data.attributes.reasons[].field_key string

The key of that field. Only on a field signal.

data.attributes.reasons[].value string

The value the two share. Only on a field signal.

data.attributes.dismissed_at integer

When somebody said these are two different people, null while the pair stands.

data.attributes.computed_at integer

When detection last looked at this pair.

Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.

PUT
curl https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/duplicates/42/dismissal \
-X PUT \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/duplicates/42/dismissal', {
method: 'PUT',
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->put('https://my.monicahq.com/api/v1/vaults/9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31/duplicates/42/dismissal');
Response 200
{
"data": {
"type": "contact_duplicate_candidate",
"id": "42",
"attributes": {
"contact_id": "c4a1f7b2-8e36-4d59-b0a7-2f5c9d81e364",
"other_contact_id": "7b2e9034-5c18-4af6-9d21-0e83b6c47a5f",
"contact_name": "Jim Halpert",
"other_contact_name": "Jimmy Halpert",
"score": 95,
"reasons": [
{
"kind": "field",
"field_key": "email",
"value": "[email protected]"
},
{
"kind": "name"
}
],
"dismissed_at": 1757548800,
"computed_at": 1757462400
}
}
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.