API v1
v1
View as Markdown

Delete a relationship type

DELETE /api/v1/relationship-types/{relationshipType}

Remove a type you added and never used.

Two types cannot go. One the product supplied stays, because the family tree and romantic history are written against it. One that relationships already use stays, because removing it would take the words off links somebody wrote down. Both answer 422 and say which it is.

Stopping the type being offered is the answer in either case: it leaves the picker, and every relationship written with it keeps reading exactly as before.

A deletion is recoverable, so an accident is not the end of anything.

Path parameters

Sent as JSON. Anything not listed here is ignored.

relationshipType uuid Required

The id of the type. A path that is not a uuid answers 404 without a query being run.

Returns

Nothing. A type that is supplied or in use answers 422 naming that reason, and one belonging to somebody else answers 404.

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/relationship-types/c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48 \
-X DELETE \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/relationship-types/c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48', {
method: 'DELETE',
headers: { Authorization: `Bearer ${token}` },
})
$response = Http::withToken($token)->delete('https://my.monicahq.com/api/v1/relationship-types/c60d8f14-9a27-4b53-8e01-2d7f5c3a6b48');
Response 204
[]

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