1. Usuários
Veploy API
  • Visão geral
  • Autenticação
  • Limites de requisição
  • Imóveis
    • Listar imóveis
    • Consultar imóvel
    • Cadastrar imóvel
    • Alterar imóvel
    • Excluir imóvel
    • Restaurar imóvel
    • Enviar foto do imóvel (Beta)
    • Remover foto do imóvel (Beta)
    • Listar tipos de imóvel
  • Proprietários
    • Listar proprietários
    • Consultar proprietário
    • Cadastrar proprietário
    • Alterar proprietário
    • Excluir proprietário
  • Leads
    • Listar leads
    • Consultar lead
    • Criar lead
    • Alterar responsável
    • Atualizar lead
    • Consultar linha do tempo do lead
  • Visitas
    • Listar visitas
    • Consultar visita
    • Agendar visita
    • Alterar visita
  • Propostas
    • Listar propostas
    • Consultar proposta
    • Registrar proposta
    • Alterar proposta
  • Portais
    • Listar portais
    • Consultar portal
    • Listar imóveis do XML
  • Usuários
    • Listar usuários
      GET
    • Consultar usuário
      GET
    • Consultar permissões do usuário
      GET
    • Convidar usuário
      POST
    • Alterar ficha do usuário
      PATCH
    • Desativar usuário
      POST
    • Reativar usuário
      POST
    • Remover usuário
      DELETE
  • Perfis de acesso
    • Listar perfis de acesso
  • Artigos
    • Listar artigos
    • Criar artigo
    • Consultar artigo
    • Alterar artigo
    • Enviar capa do artigo (Beta)
  • Temas
    • Tema do site
  1. Usuários

Desativar usuário

POST
/v1/users/{id}/deactivate
Desativa um membro ativo: o acesso e a distribuição de leads param, a conta e o histórico ficam. É reversível por POST /v1/users/{id}/reactivate e libera a vaga do plano.
A transferência é opcional. Sem destino, leads, captações e trabalho aberto continuam com a pessoa e voltam a ser dela se for reativada. Convite pendente não se desativa: cancele com DELETE /v1/users/{id}.
Respostas
200 com o usuário em data, já com status inactive.
400 VALIDATION_ERROR para destino de transferência que não é membro ativo da conta ou é o próprio usuário.
403 ROLE_NOT_MANAGEABLE quando o usuário tem cargo igual ou superior ao de quem criou a chave; 403 API_KEY_OWNER_NOT_ACTIVE quando quem criou a chave não é mais membro ativo.
404 USER_NOT_FOUND para usuário que não é membro da conta.
409 USER_ALREADY_INACTIVE ou 409 INVITE_PENDING.
422 CANNOT_DEACTIVATE_SELF para quem criou a chave; 422 LAST_ADMIN quando a conta ficaria sem administrador ativo.

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200
application/json
Default Response
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🟠409
🟠422
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.veploy.com/v1/users//deactivate' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "leads_transfer_to_id": "c2ddf60e-2ed6-4b4e-ab9a-a4cb7e16aa3c",
    "acquisition_transfer_to_id": "16c69eec-1f2d-4cc7-ba60-7543eec4e4bf"
}'
Response Response Example
200 - Exemplo 1
{
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": null,
        "email": null,
        "phone": null,
        "cpf": null,
        "creci": null,
        "birth_date": null,
        "avatar_url": null,
        "role": null,
        "status": "active",
        "lead_distribution_enabled": true,
        "username": null,
        "invited_at": "2019-08-24T14:15:22.123Z",
        "email_confirmed_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2019-08-24T14:15:22.123Z"
    }
}
Modificado em 2026-11-12 20:16:15
Página anterior
Alterar ficha do usuário
Próxima página
Reativar usuário
Built with