Delete a custom relationship type

Deletes a relationship type. Fails if any identity relationships currently reference it.

Required scope: settings:write (or legacy identities:write).

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

type_idstringRequired

Relationship type ID (crel_*).

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Response

Relationship type deleted.
deletedboolean

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error