VolundOS
Referência da APIPessoas

Convidar pessoa

Convida por e-mail com um cargo de entrada (admin, member ou collaborator) e, opcional, um perfil de entrada que quem convida precisa cobrir. O e-mail sai no idioma de quem é dono da chave; o link volta na resposta. Exige `members.invite`. Exige o escopo members:write.

Atualizado em 17 de outubro de 2026
POST
/v1/invites

Authorization

chaveDeApi
AuthorizationBearer <token>

Chave de API da organização, criada nas configurações. Envie-a em Authorization: Bearer <sua chave>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/invites" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "email": "string",  "role": "string",  "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",  "expires_at": "2019-08-24T14:15:22Z",  "invite_url": "http://example.com"}