Contas (Platform API)

Gerencie contas da plataforma NooviChat. Estes endpoints usam a Platform API e requerem autenticação com api_access_token de nível plataforma.

Platform API

Estes endpoints utilizam o prefixo /platform/api/v1 e requerem uma API key de plataforma, diferente do token de usuário.

POST/platform/api/v1/accounts

Cria uma nova conta (organização) na plataforma.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome da conta/organização
`locale`	`string`	Nao	Idioma padrão (pt_BR, en, es)
`domain`	`string`	Nao	Domínio da empresa
`support_email`	`string`	Nao	Email de suporte

bash

curl -X POST "https://chat.seudominio.com/platform/api/v1/accounts" \
  -H "api_access_token: PLATFORM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Empresa ABC",
    "locale": "pt_BR",
    "domain": "empresaabc.com.br"
  }'

200Conta criada

json

{
  "id": 5,
  "name": "Empresa ABC",
  "locale": "pt_BR",
  "domain": "empresaabc.com.br",
  "support_email": null,
  "status": "active",
  "features": {},
  "custom_attributes": {},
  "limits": {}
}

GET/platform/api/v1/accounts/{account_id}

Retorna os detalhes de uma conta específica.

Parâmetros

Nome	Tipo	Obrigatorio	Descricao
`account_id`(path)	`integer`	Sim	ID numérico da conta

bash

curl -s "https://chat.seudominio.com/platform/api/v1/accounts/5" \
  -H "api_access_token: PLATFORM_TOKEN" | jq .

200Detalhes da conta

json

{
  "id": 5,
  "name": "Empresa ABC",
  "locale": "pt_BR",
  "domain": "empresaabc.com.br",
  "status": "active"
}

PATCH/platform/api/v1/accounts/{account_id}

Atualiza os dados de uma conta existente.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Nao	Nome da conta
`locale`	`string`	Nao	Idioma
`domain`	`string`	Nao	Domínio
`support_email`	`string`	Nao	Email de suporte
`auto_resolve_duration`	`integer`	Nao	Tempo em minutos para auto-resolver conversas

bash

curl -X PATCH "https://chat.seudominio.com/platform/api/v1/accounts/5" \
  -H "api_access_token: PLATFORM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Empresa ABC Ltda", "auto_resolve_duration": 1440 }'

DELETE/platform/api/v1/accounts/{account_id}

Remove permanentemente uma conta e todos os seus dados.

bash

curl -X DELETE "https://chat.seudominio.com/platform/api/v1/accounts/5" \
  -H "api_access_token: PLATFORM_TOKEN"

Irreversível

Esta ação remove permanentemente a conta, todas as conversas, contatos, inboxes e dados associados.

Usuários da Conta

GET/platform/api/v1/accounts/{account_id}/account_users

Lista os usuários associados a uma conta.

200Array de account_users (sem envelope data)

json

[
  { "id": 1, "account_id": 5, "user_id": 10, "role": "administrator", "inviter_id": null, "custom_role_id": null },
  { "id": 2, "account_id": 5, "user_id": 11, "role": "agent", "inviter_id": 10, "custom_role_id": null }
]

POST/platform/api/v1/accounts/{account_id}/account_users

Adiciona um usuário a uma conta com uma role específica.

Body

Nome	Tipo	Obrigatorio	Descricao
`user_id`	`integer`	Sim	ID do usuário
`role`	`string`	Sim	Role: administrator ou agent

bash

curl -X POST "https://chat.seudominio.com/platform/api/v1/accounts/5/account_users" \
  -H "api_access_token: PLATFORM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "user_id": 10, "role": "agent" }'

DELETE/platform/api/v1/accounts/{account_id}/account_users

Remove um usuário de uma conta.

Body

Nome	Tipo	Obrigatorio	Descricao
`user_id`	`integer`	Sim	ID do usuário a remover

bash

curl -X DELETE "https://chat.seudominio.com/platform/api/v1/accounts/5/account_users" \
  -H "api_access_token: PLATFORM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "user_id": 10 }'