v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Editar Cliente

Alterar os dados de um Cliente. Quaisquer parâmetros não informados não serão alterados.

put/customers/{id}

Path parameters

idstring required

ID do cliente

Request body

emailstring

Email do cliente

namestring

Nome do cliente

notesstring

Notas

phoneinteger

Número do Telefone - 9 dígitos

phone_prefixinteger

Prefixo, apenas números - 3 dígitos (obrigatório caso preencha "phone")

cpf_cnpjstring

CPF ou CNPJ do cliente. <br> Aceito o campo alfanumérico apenas para CNPJ.

cc_emailsstring

Endereços de E-mail para cópia separados por vírgula

zip_codestring

CEP

numberstring

Número do endereço (obrigatório caso zip_code seja enviado)

streetstring

Rua

citystring

Cidade

statestring

Estado

districtstring

Bairro

complementstring

Complemento de endereço. Ponto de referência.

default_payment_method_idstring

ID da Forma de Pagamento padrão do cliente, "id" obtido em "Listar formas de pagamentos", quando preenchido, vai fazer cobranças automáticas das faturas geradas para este cliente, na data do vencimento ou após vencimento. Enviar "null" para desvincular o cartão das cobranças automáticas.

Response

200

idstring

emailstring

namestring

notesstring

created_atstring

updated_atstring

{"stackTrail":"paths:/customers/{id}:put:responses:200:content:application/json:schema:properties:cc_emails","oasType":"schema","type":"unknown"}

cpf_cnpjstring

zip_codestring

numberstring

complementstring

phonestring

phone_prefixstring

payment_methodsobject[]

{"stackTrail":"paths:/customers/{id}:put:responses:200:content:application/json:schema:properties:default_payment_method_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/customers/{id}:put:responses:200:content:application/json:schema:properties:proxy_payments_from_customer_id","oasType":"schema","type":"unknown"}

citystring

statestring

districtstring

streetstring

Example response

{
  "id": "6A7BE09792BA40CFB13AA504367E5E12",
  "email": "email@iugu.com",
  "name": "Nome do Cliente",
  "notes": "Nota  sobre este cliente",
  "created_at": "2025-04-03T12:04:38-03:00",
  "updated_at": "2025-04-03T12:07:31-03:00",
  "cpf_cnpj": "11343675030",
  "zip_code": "13056-344",
  "number": "60",
  "complement": "APTO 1702",
  "phone": "972312345",
  "phone_prefix": "11",
  "custom_variables": [
    {
      "name": "My-var",
      "value": "var"
    }
  ],
  "city": "Campinas",
  "state": "SP",
  "district": "Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)",
  "street": "Rua Antônio Nunes"
}