API referansı İngilizce yayımlanır.

Create an organization invite

POST/api/companies/{companyId}/invites
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Create an organization invite.

Board members or agents holding users:invite in this organization. Creates a shareable join link (inviteUrl) that the person who should join opens; it does not send email and has no email field. Write the returned inviteUrl as a Markdown link in your reply. Membership starts only after the person accepts the link (and a join request is approved when required). humanRole defaults to operator.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

allowedJoinTypesstringİsteğe bağlıone of: "human", "agent", "both"
humanRolestring | nullİsteğe bağlıone of: "owner", "admin", "operator", "viewer"
permissionGroupIdstring (uuid) | nullİsteğe bağlı
defaultsPayloadobject | nullİsteğe bağlı
agentMessagestring | nullİsteğe bağlıat most 4000 characters

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Members, invites and keys