DocumentationAPI ReferenceChangelog

Envocal API

API Reference API Changelog

Endpoints

List members of a tenant GETChange a member's role PATCHRemove a member DELETEList pending invitations GETInvite a user POSTResend an invitation POSTWithdraw an invitation DELETE
Members & invites

Invite a user

List pending invitations GET

Invitations that have not been accepted yet, sorted by email. Expired ones are included; check expiresUtc.

Resend an invitation POST

Sends the invitation email again and extends its validity to 7 days from now.

POST
/v1/tenants/{tenantId}/invites
  • If an account with this email exists, the user is added to the tenant directly and notified by email (204).
  • Otherwise an invitation email is sent with a link that is valid for 7 days (202). Inviting the same email again updates the role and resends the invitation.

Required permission: members:write

Authorization

Bearer
headerAuthorizationBearer <token>

Tenant API key (evk_…), created in Studio → Vault → API keys.

Path Parameters

tenantId*string

Tenant id, or current for the key's own tenant. Must be the key's tenant or one of its sub-tenants.

Request Body

Who to invite and with which role.

  1. body
  1. body
  2. …

An invitation to join a tenant.

email*string

Email address to invite.

role?string

Role to give: User or Admin (Owner is not assignable).

Value in"User""Admin""Owner"

Response Body

Invitation sent.

Example Request
curl -X POST 'https://api.envocal.ai/v1/tenants/string/invites' \  -H 'Content-Type: application/json' \  -d '{  "email": "string"}'
Example Response
Empty
Example Request
curl -X POST 'https://api.envocal.ai/v1/tenants/string/invites' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "string"
}'