Create Invite - Documentação DEVMOB

curl --request POST \ --url https://api.example.com/api/v1/bko/invites \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "phoneDdi": "<string>", "phoneNumber": "<string>", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "email": "jsmith@example.com", "phoneIso": "<string>" } '

{ "inviteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "invitedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "invitedUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "token": "<string>", "email": "<string>", "phoneIso": "<string>", "phoneDdi": "<string>", "phoneNumber": "<string>", "expiresAt": "2023-11-07T05:31:56Z", "acceptedAt": "2023-11-07T05:31:56Z", "revokedAt": "2023-11-07T05:31:56Z", "rejectedAt": "2023-11-07T05:31:56Z", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields

string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Create invite payload

roleId

string<uuid>

required

Role identifier

phoneDdi

string

required

International dialing code

phoneNumber

string

required

Phone number without country code

organizationId

string<uuid> | null

Organization identifier. Null for internal BKO invites.

string<email> | null

Invitee email

phoneIso

string | null

Phone ISO country code

Response

Created

Tokens de convite e ativação: membro, motorista ou ativação de conta

inviteId

string<uuid>

required

Identificador único

invitedByUserId

string<uuid>

required

Usuário que emitiu ou originou o token

invitedUserId

string<uuid> | null

required

Usuário convidado ou ativado

organizationId

string<uuid> | null

required

Organização do convite — ausente em convites internos e ativações de conta

roleId

string<uuid> | null

required

Role atribuída no aceite — usada apenas por MEMBER

type

enum<string>

required

Tipo do token (MEMBER, DRIVER ou ACCOUNT_ACTIVATION)

Available options:

MEMBER,

DRIVER,

ACCOUNT_ACTIVATION

token

string

required

Token único usado no link

string | null

required

Email do convidado ou usuário ativado, quando informado

phoneIso

string

required

Código ISO do país do telefone (padrão BR)

phoneDdi

string

required

DDI do telefone

phoneNumber

string

required

Número do telefone

expiresAt

string<date-time>

required

Data de expiração do token

acceptedAt

string<date-time> | null

required

Data em que o token foi aceito

revokedAt

string<date-time> | null

required

Data de revogação

rejectedAt

string<date-time> | null

required

Data de rejeição

createdBy

string<uuid> | null

required

Usuário que criou o registro, quando aplicável

updatedBy

string<uuid> | null

required

Usuário que fez a última atualização, quando aplicável

createdAt

string<date-time>

required

Data de criação