Skip to main content
PUT
Use este endpoint para atualizar informações de contato, comissão ou status de representadas.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.

Path Parameters

string
required
ID único da representada (UUID)

Headers

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

Body

Todos os campos são opcionais. Envie apenas os campos que deseja atualizar.
string
Nome/Razão social da representadaMínimo de 1 caractere
string
CNPJ da representadaPode ser nulo para remover
string
Email de contatoDeve ser um email válido ou nulo
string
Telefone de contatoPode ser nulo para remover
string
Endereço completoPode ser nulo para remover
string
CidadePode ser nulo para remover
string
Estado (UF)Pode ser nulo para remover
string
Nome da pessoa de contatoPode ser nulo para remover
string
Observações geraisPode ser nulo para remover
boolean
Status da representada
  • true - Representada ativa
  • false - Representada inativa

Response

Sucesso

boolean
Indica se a operação foi bem-sucedida
object
Dados completos da representada atualizada (mesma estrutura do GET)

Validações

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

Casos de Uso Comuns

Exemplos práticos:
  1. Ajustar comissão: Modifique apenas o campo comissao após negociação
  2. Atualizar contato: Atualize contato, email e telefone quando houver mudança
  3. Mudança de endereço: Atualize endereco, cidade e estado
  4. Desativar representada: Defina ativo: false ao encerrar contrato
  5. Adicionar observações: Use o campo observacao para registrar informações importantes

Dicas

Boas práticas:
  • Sempre adicione uma observação ao desativar uma representada explicando o motivo
  • Mantenha os dados de contato sempre atualizados
  • Revise periodicamente as comissões conforme desempenho
  • Use o campo observação para registrar acordos especiais ou condições