Skip to main content
POST
O sistema gera automaticamente um ID único (UUID) para cada representada criada.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.

Headers

string
required
application/json
string
required
API key de autenticação

Body

string
required
Nome/Razão social da representadaMínimo de 1 caractere
string
CNPJ da representadaFormato: XX.XXX.XXX/XXXX-XX
string
Email de contatoDeve ser um email válido
string
Telefone de contato
string
Endereço completo da representada
string
Cidade
string
Estado (UF)Exemplo: SP, RJ, MG
string
Nome da pessoa de contato na representada
string
Observações gerais sobre a representada
boolean
default:"true"
Status inicial da representada
  • true - Representada ativa
  • false - Representada inativa

Response

Sucesso

boolean
Indica se a operação foi bem-sucedida
object
Dados da representada criada

Validações

Validações aplicadas:
  • Nome deve ter pelo menos 1 caractere
  • Email deve ser válido se fornecido
  • Comissão deve estar entre 0 e 100

Dicas

Boas práticas:
  • Mantenha o CNPJ no formato padrão brasileiro
  • Use a comissão padrão que será aplicada nas vendas
  • Preencha o campo contato para facilitar a comunicação
  • Use o campo observação para informações importantes sobre prazo de pagamento, condições especiais, etc.