MeChat API

Tema Escuro

Usuários ​

A API de usuários permite gerenciar os usuários da sua empresa, incluindo cadastro, edição, desativação e restauração.

O campo external_reference é obrigatório e deve conter o ID do cliente no sistema MeEventos. Esse ID é validado contra o sistema vinculado; use apenas IDs de usuários existentes no MeEventos. O mesmo ID não pode ser vinculado a mais de um usuário ativo na mesma empresa.

Listar Usuários ​

GET https://chat.mehub.app/api/v1/users

Retorna uma lista paginada de todos os usuários da empresa.

Headers ​

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação. Ex: Bearer seu_token

Query Parameters ​

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página. Default: 1
per_pageintegerNãoRegistros por página (máx: 100). Default: 20
searchstringNãoBuscar por nome
typestringNãoFiltrar por tipo: admin, user
statusstringNãoFiltrar por status: active (ativos), inactive (desativados)

Exemplo de requisição ​

bash
curl -X GET "https://chat.mehub.app/api/v1/users?type=user&status=active" \
  -H "Authorization: Bearer SEU_TOKEN"

Response ​

json
{
  "success": true,
  "data": [
    {
      "id": 37,
      "name": "Ana Silva",
      "email": "[email protected]",
      "type": "user",
      "signature": "Ana Silva",
      "signature_active": true,
      "avatar": null,
      "external_reference": null,
      "company_id": 1,
      "created_at": "2025-10-23T15:01:02.000000Z",
      "updated_at": "2025-10-23T15:01:02.000000Z",
      "deleted_at": null
    }
  ],
  "pagination": {
    "total": 50,
    "per_page": 20,
    "current_page": 1,
    "last_page": 3
  }
}

Visualizar Usuário ​

GET https://chat.mehub.app/api/v1/users/{id}

Retorna os dados de um usuário específico.

Headers ​

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação. Ex: Bearer seu_token

Path Parameters ​

NomeTipoObrigatórioDescrição
idintegerSimID do usuário

Exemplo de requisição ​

bash
curl -X GET "https://chat.mehub.app/api/v1/users/5" \
  -H "Authorization: Bearer SEU_TOKEN"

Response ​

json
{
  "success": true,
  "data": {
    "id": 5,
    "name": "Maria Oliveira",
    "email": "[email protected]",
    "type": "user",
    "signature": "Maria Oliveira",
    "avatar": "https://storage.exemplo.com/avatars/5_1750859909.png",
    "external_reference": null,
    "channels": [
      {
        "token": "abc123def456",
        "name": "WhatsApp Vendas",
        "type": "whatsapp"
      }
    ],
    "created_at": "2025-06-24T14:19:02.000000Z",
    "updated_at": "2025-10-28T18:09:50.000000Z"
  }
}

Cadastrar Usuário ​

POST https://chat.mehub.app/api/v1/users

Cria um novo usuário na empresa.

Headers ​

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação. Ex: Bearer seu_token

Request Body ​

NomeTipoObrigatórioDescrição
namestringSimNome completo (máx: 50 caracteres, apenas letras e espaços)
emailstringSimE-mail (único por empresa)
passwordstringSimSenha (mín: 8 caracteres)
typestringSimTipo: admin ou user
external_referenceintegerSimID do cliente no sistema MeEventos. Deve ser um ID válido (existente no sistema vinculado). Não pode ser repetido entre usuários ativos da mesma empresa.
channelsarrayNãoLista de tokens dos canais que o usuário terá acesso

Usuários admin têm acesso a todos os canais. Usuários user têm acesso apenas aos canais informados em channels.

Exemplo de requisição ​

bash
curl -X POST "https://chat.mehub.app/api/v1/users" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Eduardo Silva",
    "email": "[email protected]",
    "password": "senha12345",
    "type": "user",
    "external_reference": 54,
    "channels": ["abc123def456", "xyz789ghi012"]
  }'

Response ​

json
{
  "success": true,
  "message": "Usuário criado com sucesso.",
  "data": {
    "id": 29,
    "name": "Eduardo Silva",
    "email": "[email protected]",
    "type": "user",
    "signature": "Eduardo Silva",
    "avatar": null,
    "external_reference": 54,
    "channels": [
      {
        "token": "abc123def456",
        "name": "WhatsApp Vendas",
        "type": "whatsapp"
      },
      {
        "token": "xyz789ghi012",
        "name": "WhatsApp Suporte",
        "type": "whatsapp_unofficial"
      }
    ],
    "created_at": "2025-10-30T16:56:52.000000Z",
    "updated_at": "2025-10-30T16:56:52.000000Z"
  }
}

Erros ​

CódigoDescrição
EMAIL_ALREADY_EXISTSE-mail já em uso por outro usuário da empresa
EXTERNAL_REFERENCE_ALREADY_USEDEste ID do MeEventos já está vinculado a outro atendente ativo
EXTERNAL_REFERENCE_INVALIDO ID informado não corresponde a um usuário válido no sistema MeEventos
FIELD_REQUIREDCampo obrigatório não informado (ex.: external_reference)

Exemplo:

json
{
  "success": false,
  "message": "Erro de validação",
  "errors": [
    {
      "code": "EMAIL_ALREADY_EXISTS",
      "field": "email",
      "message": "Este e-mail já está sendo usado por outro usuário da empresa."
    }
  ]
}

Editar Usuário ​

PUT https://chat.mehub.app/api/v1/users/{id}

Atualiza os dados de um usuário. Envie apenas os campos que deseja atualizar.

Headers ​

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação. Ex: Bearer seu_token

Path Parameters ​

NomeTipoObrigatórioDescrição
idintegerSimID do usuário

Request Body ​

NomeTipoObrigatórioDescrição
namestringNãoNome completo
emailstringNãoE-mail
passwordstringNãoNova senha
typestringNãoTipo: admin ou user
external_referenceintegerSimID do cliente no sistema MeEventos. Deve ser um ID válido (existente no sistema vinculado). Não pode ser repetido entre usuários ativos da mesma empresa.
channelsarrayNãoTokens dos canais (substitui os anteriores)

Exemplo de requisição ​

bash
curl -X PUT "https://chat.mehub.app/api/v1/users/29" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Eduardo Santos Silva",
    "type": "admin"
  }'

Response ​

json
{
  "success": true,
  "message": "Usuário atualizado com sucesso.",
  "data": {
    "id": 29,
    "name": "Eduardo Santos Silva",
    "email": "[email protected]",
    "type": "admin",
    "signature": "Eduardo Santos Silva",
    "avatar": null,
    "external_reference": 54,
    "channels": [],
    "created_at": "2025-10-30T16:56:52.000000Z",
    "updated_at": "2025-10-30T17:30:00.000000Z"
  }
}

Desativar Usuário ​

DELETE https://chat.mehub.app/api/v1/users/{id}

Desativa um usuário (soft delete). O usuário pode ser restaurado posteriormente.

Headers ​

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação. Ex: Bearer seu_token

Path Parameters ​

NomeTipoObrigatórioDescrição
idintegerSimID do usuário

Exemplo de requisição ​

bash
curl -X DELETE "https://chat.mehub.app/api/v1/users/29" \
  -H "Authorization: Bearer SEU_TOKEN"

Response ​

json
{
  "success": true,
  "message": "Usuário desativado com sucesso."
}

Restaurar Usuário ​

POST https://chat.mehub.app/api/v1/users/{id}/restore

Restaura um usuário previamente desativado.

Headers ​

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação. Ex: Bearer seu_token

Path Parameters ​

NomeTipoObrigatórioDescrição
idintegerSimID do usuário

Exemplo de requisição ​

bash
curl -X POST "https://chat.mehub.app/api/v1/users/29/restore" \
  -H "Authorization: Bearer SEU_TOKEN"

Response ​

json
{
  "success": true,
  "message": "Usuário ativado com sucesso."
}

Campos do Response ​

CampoTipoDescrição
idintegerID único do usuário
namestringNome completo
emailstringE-mail
typestringTipo: admin ou user
signaturestringAssinatura nas mensagens
signature_activebooleanSe a assinatura está ativa
avatarstring/nullURL da imagem de perfil
external_referenceinteger/nullID do cliente no sistema MeEventos
channelsarrayCanais vinculados
deleted_atdatetime/nullData de desativação