API ReferenceRelationship Types

Update a custom relationship type

Update label, inverse_label, description, or is_active. The slug (name) cannot be changed after creation.

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.

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:

Request

This endpoint expects an object.
labelstringOptional
inverse_labelstringOptional
descriptionstringOptional
is_activebooleanOptional
Inactive types can't be used for new relationships but existing ones still display.

Response

Updated relationship type.
idstring
org_idstring
namestring

Machine-readable slug, unique per org/environment.

labelstring

Human-readable label for the outgoing direction (what the related identity is to the source).

inverse_labelstring

Label for the reverse direction. Equal to label for symmetric types.

is_activeboolean
created_atdatetime
updated_atdatetime
descriptionstring or null

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error