Hanzo
OpenapiO11y

Invites several people to the caller's org in one call, refusing the whole…

Invites several people to the caller's org in one call, refusing the whole batch when any email repeats.

POST /v1/o11y/invite/bulk

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

Invites several people to the caller's org in one call, refusing the whole batch when any email repeats. Deprecated alongside createInvite. Admin gate.

Request

5 fields, body application/json (required).

FieldInTypeRequiredDescription
invitesbodyo11y.O11yInviteIn[]Invites are the invitations to create; an email may appear only once.
invites[].emailbodystringEmail is the address the invitation goes to.
invites[].frontendBaseUrlbodystringFrontendBaseUrl is the console origin the invite link is built on.
invites[].namebodystringName is the invitee's display name.
invites[].rolebodystringRole is the role they will hold on accepting — ADMIN, EDITOR or VIEWER.

Response

StatusBodyMeaning
201o11y.O11yAckcreated

201 body — 1 field.

FieldInTypeAlwaysDescription
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y invite bulk

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page