API v1
v1
View as Markdown

Delete a relationship

DELETE /api/v1/vaults/{vault}/contacts/{contact}/relationships/{relationship}

Delete a relationship. It leaves both people at once.

Neither person is deleted, including somebody who existed only through this relationship.

Path parameters

Sent as JSON. Anything not listed here is ignored.

vault string Required

The vault both people live in, named either by the readable name it reports as slug or by its id.

contact string Required

One of the two people, named either by their slug or by their id. A contact addressed through the wrong vault answers 404.

relationship uuid Required

The id of the relationship. It is reached through either of its two people, and through anybody else answers 404.

Returns

Nothing at all.

Rate limit

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

DELETE
curl https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185 \
-X DELETE \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185', {
method: 'DELETE',
headers: { Authorization: `Bearer ${token}` },
})
$response = Http::withToken($token)->delete('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185');
Response 204

No content.

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