Invite people by e-mail

POST/api/companies/{companyId}/invites/email
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 1 · History

Invite people by e-mail.

Board members holding users:invite in this organization, with a verified e-mail. Creates one invite per address (at most 20) in the chosen permission group, and Veyra Connect e-mails each person a link to its invitation page. There they accept with their Veyra Intelligence account (or create one), and the invite then joins them to the organization.

Authorization

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

emailsarray<string (email)>Requiredeach at most 254 characters
permissionGroupIdstring (uuid)Required
messagestring | nullOptionalat most 1000 characters

Responses

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Members, invites and keys