Skip to main content
POST
/
organizations
/
{organizationId}
/
invitations
/
{invitationId}
/
revoke
Revogar Convite
curl --request POST \
  --url https://api.example.com/organizations/{organizationId}/invitations/{invitationId}/revoke \
  --header 'Authorization: <authorization>'
{
  "invitationId": "inv_abc123",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "inviterUserId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "acceptedUserId": null,
  "email": "jane@example.com",
  "token": "tok_abc123",
  "acceptInvitationUrl": "https://app.awsales.com/invite?token=tok_abc123",
  "roleSlug": "member",
  "state": "REVOKED",
  "expiresAt": "2026-04-25T14:00:00.000Z",
  "acceptedAt": null,
  "revokedAt": "2026-03-25T15:00:00.000Z",
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T15:00:00.000Z"
}
Requer permissao invitations:revoke.

Headers

Authorization
string
required
Bearer token.

Parametros de Path

organizationId
string
required
UUID da organizacao.
invitationId
string
required
ID do convite.

Resposta

invitationId
string
ID do convite.
organizationId
string
UUID da organizacao.
inviterUserId
string
ID do usuario que convidou.
acceptedUserId
string
ID do usuario que aceitou.
email
string
Email convidado.
token
string
Token do convite.
acceptInvitationUrl
string
URL para aceitar o convite.
roleSlug
string
Slug do papel.
state
string
Estado do convite.
expiresAt
string
Data de expiracao.
acceptedAt
string
Timestamp de aceitacao.
revokedAt
string
Timestamp de revogacao.
createdAt
string
Timestamp de criacao.
updatedAt
string
Timestamp da ultima atualizacao.
{
  "invitationId": "inv_abc123",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "inviterUserId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "acceptedUserId": null,
  "email": "jane@example.com",
  "token": "tok_abc123",
  "acceptInvitationUrl": "https://app.awsales.com/invite?token=tok_abc123",
  "roleSlug": "member",
  "state": "REVOKED",
  "expiresAt": "2026-04-25T14:00:00.000Z",
  "acceptedAt": null,
  "revokedAt": "2026-03-25T15:00:00.000Z",
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T15:00:00.000Z"
}

Exemplos de Codigo

curl -X POST https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/invitations/inv_01HQZE7N9K4RW2X6MTJP8YCDF3/revoke \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Uma vez revogado, o link do convite se torna permanentemente invalido. O convidado precisara de um novo convite para ingressar.

Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
403auth.invitation_not_pendingO convite nao esta em estado pendente
404organization.not_foundOrganizacao nao encontrada
404invitation.not_foundConvite nao encontrado
500internal_server_errorOcorreu um erro inesperado