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

Change a member's role

List members of a tenant GET

Direct members only, sorted by email. Members of parent tenants also have access but are listed at their own tenant.

Remove a member DELETE

Removes the user's membership of this tenant. The user account itself is not deleted.

PATCH
/v1/tenants/{tenantId}/members/{userId}

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.

userId*string

User id of the member (from the member list).

Request Body

The new role.

  1. body
  1. body
  2. …

A new role for a member.

role?string

User or Admin (Owner is not assignable).

Value in"User""Admin""Owner"

Response Body

Role changed.

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