Skip to main content
POST
/
organizations
/
{organizationId}
/
invitations
Enviar Convite
curl --request POST \
  --url https://api.example.com/organizations/{organizationId}/invitations \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "roleSlug": "<string>",
  "expiresInDays": 123,
  "inviterUserId": "<string>"
}
'
{
  "invitationId": "inv_abc123",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "inviterUserId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "acceptedUserId": null,
  "email": "jane@example.com",
  "token": "tok_invitation_xyz",
  "acceptInvitationUrl": "https://app.awsales.com/invite?token=tok_invitation_xyz",
  "roleSlug": null,
  "state": "PENDING",
  "expiresAt": "2026-04-25T14:00:00.000Z",
  "acceptedAt": null,
  "revokedAt": null,
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T14:00:00.000Z"
}
Envia um convite. 
curl -X POST https://api.awsales.io/studio/organizations/ORG_ID/invitations \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "roleSlug": "member",
    "expiresInDays": 7
  }'
Requer permissao invitations:write.

​
Cabecalhos

​
Authorization
string
required
Token bearer.

​
Parametros de Rota

​
organizationId
string
required
O UUID da organizacao.

​
Corpo da Requisicao

​
email
string
required
Endereco de email para convidar.
​
roleSlug
string
Slug do role opcional a ser atribuido na aceitacao.
​
expiresInDays
integer
Numero de dias ate o convite expirar.
​
inviterUserId
string
O ID do usuario que convidou.

​
Resposta

​
invitationId
string
O ID do convite.
​
organizationId
string
O UUID da organizacao.
​
inviterUserId
string
O ID do usuario que convidou.
​
acceptedUserId
string | null
O ID do usuario do membro que aceitou o convite.
​
email
string
O endereco de email convidado.
​
token
string
O token de convite.
​
acceptInvitationUrl
string
URL para aceitar o convite.
​
roleSlug
string | null
O slug do role atribuido na aceitacao.
​
state
string
O estado do convite.
​
expiresAt
string
Timestamp de expiracao ISO 8601.
​
acceptedAt
string | null
Timestamp ISO 8601 de quando o convite foi aceito.
​
revokedAt
string | null
Timestamp ISO 8601 de quando o convite foi revogado.
​
createdAt
string
Timestamp de criacao ISO 8601.
​
updatedAt
string
Timestamp da ultima atualizacao ISO 8601.
{
  "invitationId": "inv_abc123",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "inviterUserId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "acceptedUserId": null,
  "email": "jane@example.com",
  "token": "tok_invitation_xyz",
  "acceptInvitationUrl": "https://app.awsales.com/invite?token=tok_invitation_xyz",
  "roleSlug": null,
  "state": "PENDING",
  "expiresAt": "2026-04-25T14:00:00.000Z",
  "acceptedAt": null,
  "revokedAt": null,
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T14:00:00.000Z"
}

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
409invitation.already_invitedUsuario ja foi convidado
500internal_server_errorOcorreu um erro inesperado