VIvindi
customers

Atualiza um cliente existente através do ID.

Utilize este método para atualizar um cliente existente.

Atualizando números de telefone

A lista de números de telefone associada ao cliente é representada pelo array phones.

  • Para atualizar um objeto existente no array phones, simplesmente indique seu ID e os novos atributos.
  • Para criar um novo objeto, informe apenas os atributos sem o ID.
  • Para remover um objeto existente, inclua o atributo "_destroy": "1", sem esquecer de informar o ID.

Além disso é possível omitir o parâmetro phones na requisição para não atualizar os produtos relacionados.

put/v1/customers/{id}

Request

  • Base URL
    //app.vindi.com.br/api (relative, and the document’s source URL is not known)
  • URL
    //app.vindi.com.br/api/v1/customers/{id}
  • Auth
    HTTP basic

Path parameters

idinteger required

ID do cliente que deverá ser atualizado.

Request body

bodystring
namestring required

Nome do cliente

emailstring

E-mail do cliente

registry_codestring

CPF ou CNPJ do cliente

codestring

Código opcional para referência via API

notesstring

Observações adicionais internas sobre o cliente

metadata'array'

Metadados do cliente

Response

Cliente atualizado com sucesso.

idinteger required

ID do cliente

namestring required

Nome do cliente

emailstring

E-mail do cliente

registry_codestring

CPF ou CNPJ do cliente

codestring

Código opcional para referência via API

notesstring

Observações adicionais internas sobre o cliente

status'active' | 'inactive' | 'archived' required

Status do cliente

created_atstring required

Data e hora do cadastro do cliente

updated_atstring required

Data e hora da última atualização do cliente

metadataobject

Metadados do cliente

Changes

No recorded changes to this operation across all 1 revision of this API.