curl -X PUT "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"telefone": "(11) 3456-7899",
"email": "[email protected]",
"observacao": "Cliente VIP - Desconto especial 5%"
}'
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"ativo": false,
"observacao": "Cliente temporariamente inativo - Reforma da loja"
}'
// Atualizar dias de atendimento
const updateData = {
segunda: false,
terca: true,
quarta: true,
quinta: true,
sexta: true,
observacao: "Não atende às segundas - loja fechada"
};
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify(updateData)
});
const result = await response.json();
if (result.success) {
console.log('Cliente atualizado:', result.data);
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
# Atualizar endereço completo
data = {
"endereco": "Avenida Paulista, 2000",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"estado": "SP"
}
response = requests.put(url, headers=headers, json=data)
result = response.json()
if response.status_code == 200:
print("Cliente atualizado com sucesso!")
print(f"Nome: {result['data']['nome']}")
print(f"Novo endereço: {result['data']['endereco']}, {result['data']['bairro']}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"codigo": "CLI-001",
"nome": "Supermercado Central",
"email": "[email protected]",
"telefone": "(11) 3456-7899",
"cnpj_cpf": "12.345.678/0001-90",
"endereco": "Avenida Paulista, 2000",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"estado": "SP",
"observacao": "Cliente VIP - Desconto especial 5%",
"ativo": true,
"segunda": false,
"terca": true,
"quarta": true,
"quinta": true,
"sexta": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-26T15:45:00Z"
}
}
{
"error": "Cliente não encontrado"
}
{
"error": "Dados de entrada inválidos",
"details": [
{
"code": "invalid_string",
"validation": "email",
"message": "Invalid email",
"path": ["email"]
}
]
}
Clientes
Atualizar Cliente
Atualiza os dados de um cliente existente
PUT
/
api
/
v1
/
clients
/
{id}
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"telefone": "(11) 3456-7899",
"email": "[email protected]",
"observacao": "Cliente VIP - Desconto especial 5%"
}'
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"ativo": false,
"observacao": "Cliente temporariamente inativo - Reforma da loja"
}'
// Atualizar dias de atendimento
const updateData = {
segunda: false,
terca: true,
quarta: true,
quinta: true,
sexta: true,
observacao: "Não atende às segundas - loja fechada"
};
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify(updateData)
});
const result = await response.json();
if (result.success) {
console.log('Cliente atualizado:', result.data);
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
# Atualizar endereço completo
data = {
"endereco": "Avenida Paulista, 2000",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"estado": "SP"
}
response = requests.put(url, headers=headers, json=data)
result = response.json()
if response.status_code == 200:
print("Cliente atualizado com sucesso!")
print(f"Nome: {result['data']['nome']}")
print(f"Novo endereço: {result['data']['endereco']}, {result['data']['bairro']}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"codigo": "CLI-001",
"nome": "Supermercado Central",
"email": "[email protected]",
"telefone": "(11) 3456-7899",
"cnpj_cpf": "12.345.678/0001-90",
"endereco": "Avenida Paulista, 2000",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"estado": "SP",
"observacao": "Cliente VIP - Desconto especial 5%",
"ativo": true,
"segunda": false,
"terca": true,
"quarta": true,
"quinta": true,
"sexta": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-26T15:45:00Z"
}
}
{
"error": "Cliente não encontrado"
}
{
"error": "Dados de entrada inválidos",
"details": [
{
"code": "invalid_string",
"validation": "email",
"message": "Invalid email",
"path": ["email"]
}
]
}
Permite atualizar qualquer campo do cliente. Envie apenas os campos que deseja modificar.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.
Path Parameters
string
required
ID único do cliente (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
Código do cliente
string
Nome completo do clienteMínimo de 1 caractere
string
Email do clienteDeve ser um email válido
string
Telefone do cliente
string
CNPJ ou CPF do cliente
string
Endereço completo
string
Bairro
string
Cidade
string
Estado (UF)
string
Observações gerais sobre o cliente
boolean
Status do cliente
true- Cliente ativofalse- Cliente inativo
boolean
Define se o cliente atende às segundas-feiras
boolean
Define se o cliente atende às terças-feiras
boolean
Define se o cliente atende às quartas-feiras
boolean
Define se o cliente atende às quintas-feiras
boolean
Define se o cliente atende às sextas-feiras
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"telefone": "(11) 3456-7899",
"email": "[email protected]",
"observacao": "Cliente VIP - Desconto especial 5%"
}'
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"ativo": false,
"observacao": "Cliente temporariamente inativo - Reforma da loja"
}'
// Atualizar dias de atendimento
const updateData = {
segunda: false,
terca: true,
quarta: true,
quinta: true,
sexta: true,
observacao: "Não atende às segundas - loja fechada"
};
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify(updateData)
});
const result = await response.json();
if (result.success) {
console.log('Cliente atualizado:', result.data);
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
# Atualizar endereço completo
data = {
"endereco": "Avenida Paulista, 2000",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"estado": "SP"
}
response = requests.put(url, headers=headers, json=data)
result = response.json()
if response.status_code == 200:
print("Cliente atualizado com sucesso!")
print(f"Nome: {result['data']['nome']}")
print(f"Novo endereço: {result['data']['endereco']}, {result['data']['bairro']}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
Response
Sucesso
boolean
Indica se a operação foi bem-sucedida
object
Dados completos do cliente atualizado (mesma estrutura do GET)
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"codigo": "CLI-001",
"nome": "Supermercado Central",
"email": "[email protected]",
"telefone": "(11) 3456-7899",
"cnpj_cpf": "12.345.678/0001-90",
"endereco": "Avenida Paulista, 2000",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"estado": "SP",
"observacao": "Cliente VIP - Desconto especial 5%",
"ativo": true,
"segunda": false,
"terca": true,
"quarta": true,
"quinta": true,
"sexta": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-26T15:45:00Z"
}
}
{
"error": "Cliente não encontrado"
}
{
"error": "Dados de entrada inválidos",
"details": [
{
"code": "invalid_string",
"validation": "email",
"message": "Invalid email",
"path": ["email"]
}
]
}
Validações
Validações aplicadas:
- Email deve ser válido se fornecido
- Nome deve ter pelo menos 1 caractere se fornecido
- Cliente deve existir no sistema
Casos de Uso
Exemplos de uso comum:
- Desativar cliente temporariamente: Defina
ativo: falsecom uma observação explicativa - Atualizar dias de atendimento: Modifique os campos de dias da semana conforme necessário
- Correção de dados: Atualize informações incorretas como endereço, telefone ou email
- Adicionar observações: Use o campo observação para notas importantes sobre o cliente