Hanzo
OpenapiO11y

Invites one person to the caller's org by email, with the role they will hold…

Invites one person to the caller's org by email, with the role they will hold when they accept.

POST /v1/o11y/invite

Addresshttps://api.hanzo.ai/v1/o11y/invite
MethodPOST
OperationCreateInvite
AuthAuthorization: Bearer $HANZO_API_KEY

Invites one person to the caller's org by email, with the role they will hold when they accept. Deprecated in favor of creating users directly; kept because callers still hold it. Admin gate, enforced by the runtime this op relays to.

Request

4 fields, body application/json (required).

FieldInTypeRequiredDescription
emailbodystringEmail is the address the invitation goes to.
frontendBaseUrlbodystringFrontendBaseUrl is the console origin the invite link is built on.
namebodystringName is the invitee's display name.
rolebodystringRole is the role they will hold on accepting — ADMIN, EDITOR or VIEWER.

Response

StatusBodyMeaning
201o11y.O11yInviteOutcreated

201 body — 11 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yInvite
data.createdAtbodystring (date-time)CreatedAt is when it was created.
data.emailbodystringEmail is the address it was sent to.
data.idbodystringID is the invitation's id.
data.inviteLinkbodystringInviteLink is the full link mailed to them.
data.namebodystringName is the invitee's display name.
data.orgIdbodystringOrgID is the org they are invited into.
data.rolebodystringRole is the role the invitee will hold.
data.tokenbodystringToken is the secret that redeems it.
data.updatedAtbodystring (date-time)UpdatedAt is when it last changed.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y invite create

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page