Skip to navigation

Define a custom verb

API key required. Adds a tenant-specific verb to the vocabulary so the tenant’s own domain language (e.g. phi.export, trade.settle) can carry policy. Names are lowercase domain.action-style: 1–64 characters of letters, digits, dots, and underscores, with at least one dot — bare words are reserved for built-in verbs. A name may not collide with a built-in verb (case-insensitive) or an existing custom verb. A custom verb can be used in verb policies the moment it is created. Writes a VERB_CREATE receipt. Limited to 200 verbs per tenant, including deprecated ones.

Request

This endpoint expects an object.
namestringRequired
The verb name, e.g. phi.export. Stored lowercase.
descriptionstringOptional

What the verb means — shown in the dashboard and docs.

Response

The created verb record.

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error