Criar conta - MultiChat

POST /webhook/core/v1/company

Documentação viva para criação de conta

Um portal de integração orientado a desenvolvedores para consultar endpoint, autenticação, payload, exemplos de código e respostas esperadas da operação de criação de conta no MultiChat com identidade visual alinhada à Fasterisk.

Método

POST

Formato

application/json

Auth

Bearer Token

Painel técnico ilustrando um portal de documentação de API

Endpoint ativo

https://srv5.fasterisk.app.br/webhook/core/v1/company

Resposta documentada

200 OK e 500 Error

00Seção

Visão geral da operação

A operação cadastra uma nova empresa na plataforma a partir de dados cadastrais, informações do responsável, recursos habilitados e limites de configuração inicial. O portal consolida os pontos críticos da integração em uma experiência única de consulta.

Objetivo

Cadastrar uma nova conta/empresa com parâmetros estruturados de operação.

Autenticação

A requisição exige envio do header Authorization com Bearer Token.

Estrutura

O corpo combina dados principais, objeto owner, listas de recursos e objeto config.

01Seção

Endpoint e cabeçalhos obrigatórios

O método, a URL e os cabeçalhos principais estão organizados abaixo para consulta rápida. O portal destaca explicitamente a autenticação por Bearer Token para reduzir ambiguidades durante a implementação.

Método

POST

URL

https://srv5.fasterisk.app.br/webhook/core/v1/company

Content-Type

application/json

Authorization

Bearer Token

Detalhe visual de console com payload e status

Autenticação

Envie o token no formato Authorization: Bearer <TOKEN>em todas as chamadas autenticadas.

02Seção

Payload da requisição

O corpo abaixo representa a estrutura solicitada para criação da conta. O bloco pode ser copiado integralmente e usado como base de testes e integração.

Request body/json

{
  "documentType": "CPF",
  "documentId": "80352073187",
  "legalName": "Razão social da empresa",
  "name": "Nome fantasia da empresa",
  "owner": {
    "name": "Medware",
    "email": "[email protected]",
    "phoneNumber": "61999999999"
  },
  "type": "UNDEFINED",
  "status": "ONBOARDING",
  "apps": [
    "SESSION_REASON",
    "WEBHOOK",
    "DIALOG",
    "SEQUENCE"
  ],
  "resourcers": [
    "WEBHOOK_API",
    "CUSTOM_FIELDS"
  ],
  "config": {
    "session": 10,
    "agents": 5,
    "panels": 5,
    "chatBots": 5,
    "chatbotAutomations": 5,
    "whatsAppChannels": 1,
    "sequences": 1
  }
}

03Seção

Descrição dos campos

A tabela a seguir resume o papel de cada atributo principal da requisição, indicando tipo, obrigatoriedade prática e função operacional no contexto da criação da conta.

Campo	Tipo	Obrigatoriedade prática	Descrição
`documentType`	string	Recomendado	Tipo de documento da empresa. Valores aceitos: CPF ou CNPJ.
`documentId`	string \| null	Recomendado	Número do documento correspondente ao tipo informado.
`legalName`	string \| null	Recomendado	Razão social da empresa.
`name`	string \| null	Recomendado	Nome fantasia da empresa.
`owner`	object	Recomendado	Objeto com os dados do responsável da conta.
`category`	string \| null	Opcional	Categoria da empresa.
`customCategory`	string \| null	Opcional	Categoria personalizada da empresa, quando aplicável.
`apps`	array[string] \| null	Opcional	Lista de módulos habilitados para a conta.
`resourcers`	array[string] \| null	Opcional	Lista de recursos adicionais habilitados.
`config`	object	Recomendado	Configuração inicial da conta para criação.
`type`	string	Recomendado	Tipo da conta. Valores aceitos: UNDEFINED, MEI, LIMITED, INDIVIDUAL e ASSOCIATION.
`status`	string	Recomendado	Status inicial da conta. Valores aceitos: DEMO e ONBOARDING.

Valores aceitos

documentType

CPF, CNPJ

Valores aceitos

type

UNDEFINED, MEI, LIMITED, INDIVIDUAL, ASSOCIATION

Valores aceitos

status

DEMO, ONBOARDING

04Seção

Objetos internos da operação

Os objetos internos concentram as informações do responsável da conta e a configuração operacional inicial. Separá-los em tabelas dedicadas torna a implementação mais objetiva e reduz erros de montagem do JSON.

Objeto owner

Campo	Tipo	Exemplo	Descrição
`owner.name`	string	Medware	Nome do responsável pela conta.
`owner.email`	string	[email protected]	E-mail do responsável.
`owner.phoneNumber`	string	61999999999	Telefone do responsável, preferencialmente apenas números.

Objeto config

Campo	Tipo	Exemplo	Descrição operacional
`config.session`	number	10	Quantidade limite relacionada a sessões.
`config.agents`	number	5	Quantidade de agentes operacionais.
`config.panels`	number	5	Quantidade de painéis disponíveis.
`config.chatBots`	number	5	Quantidade de chatbots permitidos.
`config.chatbotAutomations`	number	5	Quantidade de automações de chatbot.
`config.whatsAppChannels`	number	1	Quantidade de canais WhatsApp liberados.
`config.sequences`	number	1	Quantidade de sequências permitidas.

05Seção

Exemplos executáveis

Os blocos abaixo foram organizados para facilitar testes rápidos. Alterne entre exemplos de cURL, JavaScript e respostas da API sem sair da mesma área de leitura.

cURL/bash

curl --request POST \
  --url https://srv5.fasterisk.app.br/webhook/core/v1/company \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'authorization: Bearer <TOKEN>' \
  --data '{
  "documentType": "CPF",
  "documentId": "80352073187",
  "legalName": "Razão social da empresa",
  "name": "Nome fantasia da empresa",
  "owner": {
    "name": "Medware",
    "email": "[email protected]",
    "phoneNumber": "61999999999"
  },
  "type": "UNDEFINED",
  "status": "ONBOARDING",
  "apps": [
    "SESSION_REASON",
    "WEBHOOK",
    "DIALOG",
    "SEQUENCE"
  ],
  "resourcers": [
    "WEBHOOK_API",
    "CUSTOM_FIELDS"
  ],
  "config": {
    "session": 10,
    "agents": 5,
    "panels": 5,
    "chatBots": 5,
    "chatbotAutomations": 5,
    "whatsAppChannels": 1,
    "sequences": 1
  }
}'

06Seção

Respostas esperadas

A integração prevê retorno de sucesso com os dados persistidos da empresa e uma estrutura de erro padronizada para falhas internas. Os códigos e significados principais estão resumidos abaixo.

Status HTTP	Significado
`200`	Sucesso com retorno dos dados cadastrais e metadados da empresa criada.
`500`	Erro interno do servidor com payload estruturado de falha.

Leitura rápida

Em caso de sucesso, a API retorna identificadores, timestamps, dados cadastrais e configuração consolidada da conta. Em caso de falha interna, devolve um objeto com chave de erro, texto descritivo, identificadores e metadados de ambiente.

Painel visual abstrato representando fluxos e respostas de API

200 OK

Empresa criada com sucesso e retorno dos dados persistidos.

500 Error

Erro interno com payload estruturado para rastreabilidade da falha.