Pular para o conteúdo
platform
PT EN

Referência da API · Clientes · Gestão de Clientes

Atualizar Dados Cadastrais do Cliente

Método
PUT
Rota
/v1/customer/:document
URL base
https://ws.autorei.net
Parâmetros de rota
:document
Token
Exige token Bearer
Testar no Postman

Abre esta requisição na documentação pública da API, a fonte oficial da referência.

Descrição

Atualiza o cadastro de um cliente da sua loja. É uma atualização parcial: envie só os campos que quer mudar.

Parâmetros de Rota

Parâmetro Tipo Obrigatório Descrição
document string Sim CPF ou CNPJ do cliente.

Corpo da Requisição (JSON)

Todos os campos são opcionais, campo omitido não é alterado.

Campo Tipo Descrição
name · tradingName · contactName string Nome, nome fantasia e contato.
phone string Telefone do cliente.
stateRegistration string Inscrição estadual.
cnae string CNAE do cliente.
paysIcms boolean Se é contribuinte de ICMS.
politicallyExposedPerson · federalEmployee boolean Marcações de perfil.
optinTracking · trackingPhone - Aceite e telefone do acompanhamento.
active boolean Ativa ou inativa o cliente.
passwordExpired boolean Marca a senha como expirada.
sendEmailForgotPassword boolean true dispara o e-mail de redefinição de senha ao cliente.
ssoConfigId integer Configuração de SSO.
customerRegistrationAddress objeto Endereço de cadastro, no mesmo formato da criação.
priceRuleTags array Tags de preço, por nome. Substitui os vínculos atuais.
customerTypeList array Tipos de cliente. Substitui os vínculos atuais.
customerGroupList array Grupos de cliente. Substitui os vínculos atuais.

Regras de negócio

active aqui faz o mesmo que o endpoint de status

Enviar active nesta rota tem o mesmo efeito de PUT /customer/updateStatus/:document/:active. Os dois caminhos existem e mudam a mesma coisa.

Corpo vazio é aceito

{} responde 200 com o cadastro atual, sem alterar nada. Não é erro.

Resposta · 200

O cliente atualizado, na raiz (sem o envelope customer).

Campo Tipo Descrição
id integer Id do cliente na CWS.
document string CPF ou CNPJ do cliente.
documentType string pf ou pj.
name string Nome ou razão social.
tradingName string Nome fantasia.
contactName string Nome do contato.
email string E-mail de acesso do cliente.
phone string Telefone, já formatado ((31) 99999-9999).
dateCreated string Data e hora do cadastro.
active boolean Se o cliente está ativo.
passwordExpired boolean Se a senha está marcada como expirada.
stateRegistration string Inscrição estadual. Vem "isento" quando não informada.
cnae string CNAE do cliente.
paysIcms boolean Se é contribuinte de ICMS.
genre string Gênero.
birthdate string Data de nascimento.
politicallyExposedPerson boolean Se é pessoa politicamente exposta.
federalEmployee boolean Se é servidor público federal.
optinTracking boolean Se aceita acompanhamento por mensagem.
trackingPhone string Telefone do acompanhamento.
optinPath string Origem do consentimento.
address array Endereços do cliente, no mesmo formato de GET /customer/addresses/:document.
customerRegistrationAddress objeto Endereço de cadastro.
priceRuleTag array Tags de preço do cliente. Vem null quando não há vínculo.
customerTypeList array Tipos de cliente vinculados. null quando não há vínculo.
customerGroupList array Grupos de cliente vinculados. null quando não há vínculo.

Erros

Código Quando
422 Falha de validação, no formato Property [campo] with value [x] does not pass validation.
404 Documento sem cadastro na sua loja.
401 Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request PUT 'https://ws.autorei.net/v1/customer/:document' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "contactName": "Ana Paula Ribeiro",
  "phone": "11912345678",
  "optinTracking": false
}'

Respostas de exemplo

200Sucesso: telefone e aceite atualizados

{
  "id": 4470601,
  "document": "700.413.648-56",
  "documentType": "pf",
  "name": "Ana Paula Ribeiro",
  "tradingName": null,
  "contactName": "Ana Paula Ribeiro",
  "email": "ana.ribeiro@exemplo.com.br",
  "phone": "(11) 91234-5678",
  "dateCreated": "2026-09-01T13:42:07Z",
  "active": true,
  "passwordExpired": false,
  "stateRegistration": "isento",
  "cnae": null,
  "paysIcms": false,
  "genre": "F",
  "birthdate": "1988-04-12",
  "politicallyExposedPerson": false,
  "federalEmployee": false,
  "optinTracking": false,
  "trackingPhone": "(11) 98765-4321",
  "optinPath": "API",
  "address": [
    {
      "id": 4470701,
      "name": "Endereço de cadastro",
      "zipcode": "01310-100",
      "street": "Avenida Paulista",
      "number": "1578",
      "complement": "Conjunto 42",
      "quarter": "Bela Vista",
      "city": "São Paulo",
      "state": "SP",
      "principal": true,
      "addressType": "RESIDENTIAL",
      "farmerStateRegistration": null,
      "howToReachLocationDescription": null,
      "responsibleContact": null,
      "attributes": {},
      "dateCreated": "2026-09-01T13:42:07Z",
      "lastUpdated": "2026-09-01T13:42:07Z"
    }
  ],
  "customerRegistrationAddress": {
    "id": 4470701,
    "name": "Endereço de cadastro",
    "zipcode": "01310-100",
    "street": "Avenida Paulista",
    "number": "1578",
    "complement": "Conjunto 42",
    "quarter": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "principal": true,
    "addressType": "RESIDENTIAL",
    "farmerStateRegistration": null,
    "howToReachLocationDescription": null,
    "responsibleContact": null,
    "attributes": {},
    "dateCreated": "2026-09-01T13:42:07Z",
    "lastUpdated": "2026-09-01T13:42:07Z"
  },
  "priceRuleTag": null,
  "customerTypeList": null,
  "customerGroupList": null
}

Usado em

Endpoints relacionados

← Ver o grupo: Clientes

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.