Skip to main content
POST
/
api
/
v1
/
bko
/
users
/
{userId}
/
block
Block User
curl --request POST \
  --url https://api.example.com/api/v1/bko/users/{userId}/block
{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "googleProviderId": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phoneIso": "<string>",
  "phoneDdi": "<string>",
  "phoneNumber": "<string>",
  "phoneVerified": true,
  "emailVerified": true,
  "avatar": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
userId
string<uuid>
required

User identifier

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.

Response

OK

Identidade global do sistema — credenciais e dados de acesso. A senha nunca é retornada pela API.

​
userId
string<uuid>
required

Identificador único

​
googleProviderId
string | null
required

ID do provedor Google OAuth

​
name
string
required

Nome completo do usuário

​
email
string | null
required

Email do usuário

​
phoneIso
string
required

Código ISO do país do telefone

​
phoneDdi
string
required

DDI do telefone

​
phoneNumber
string
required

Número do telefone

​
phoneVerified
boolean
required

Indica se o telefone foi verificado

​
emailVerified
boolean
required

Indica se o email foi verificado

​
avatar
string | null
required

Object key do avatar no storage

​
status
enum<string>
required

Status da conta

Available options:
PENDING,
ACTIVE,
BLOCKED
​
createdBy
string<uuid> | null
required

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

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

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

​
updatedAt
string<date-time>
required

Data da última atualização

​
deletedBy
string<uuid> | null
required

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

​
deletedAt
string<date-time> | null
required

Data de remoção