Voltar ao site
Clientes

Atualizar cliente

PATCH/v1/customers/{id}

Atualização parcial de name, email, phone e address. Campo omitido não muda; null não apaga (422). Em COMPANY, name substitui a razão social.

X-Merchant-Id é obrigatório com credencial de organização; com credencial de merchant é opcional (ausente = o próprio merchant).

Authorization

kodanoOAuth payments:customers:write
headerAuthorizationBearer <token>

Token obtido no Zitadel do ambiente (POST /oauth/v2/token), fora do host da API, e enviado em Authorization: Bearer <access_token>.

  • Sandbox: https://kodano-uat-p55zt6.us1.zitadel.cloud/oauth/v2/token
  • Produção: https://kodano-prod-qe8hbt.us1.zitadel.cloud/oauth/v2/token

Use sempre o tokenUrl devolvido na emissão da credencial. Duas variantes: private_key_jwt (preferida; grant urn:ietf:params:oauth:grant-type:jwt-bearer com assertion RS256 assinada pela chave da credencial, iss = sub = userId, aud = authority do Zitadel, kid = keyId) e client_secret (grant client_credentials). O OpenAPI só modela a segunda.

O parâmetro scope do token é OIDC, não os escopos da API: openid urn:zitadel:iam:org:project:id:<projectId da API>:aud urn:zitadel:iam:user:resourceowner. Sem o :aud a API responde 401 AUTH.TOKEN_INVALID; sem resourceowner, 403 AUTH.TENANT_MISMATCH.

Os 28 escopos abaixo são os entitlements concedidos à credencial pelos produtos de integração (produto:recurso:ação; write não implica read), avaliados a cada requisição; não são pedidos no token. O tenant vem da organização do token; o merchant, de X-Merchant-Id. Revogar a credencial nega os tokens já emitidos em até 60 s.

Scope: payments:customers:write

Path Parameters

id*string

Id do cliente (cus_…).

Header Parameters

X-Merchant-Id*string

Merchant da operação (mrc_ + Guid sem hífens, minúsculo). Obrigatório com credencial de organização (ausente → 400 MERCHANT.HEADER_REQUIRED); com credencial de merchant é opcional (ausente = o próprio merchant). Malformado, repetido, inexistente ou de outro tenant → 403 MERCHANT.FORBIDDEN (nunca 404). Vazio = ausente.

Match^mrc_[0-9a-f]{32}$
X-Correlation-Id?string

Opcional, sempre ecoado na resposta e repetido em correlationId do Problem. Ausente ou inválido → o serviço gera UUID v7.

Match^[A-Za-z0-9._-]{1,64}$

Request Body

application/json
  1. body

Parcial: só name, email, phone e address; omitido não muda; null → 422; document/type → 422 CUSTOMER.DOCUMENT_IMMUTABLE.

Properties1 <= properties
name?string
Length1 <= length <= 150
email?string
Formatemail
Lengthlength <= 100
phone?
address?

Response Body

Cliente atualizado.

application/json
  1. response
id*string

cus_ + 16 caracteres.

Match^cus_
type*string

Derivado do document, nunca enviado.

Value in"INDIVIDUAL""COMPANY"
name*string
Length1 <= length <= 150
document*string

Completo só neste recurso; embutido em link ou pagamento sai mascarado.

email*string
Lengthlength <= 100
phone*|null
address*|null
createdAt*string

Quando a pessoa virou cliente; base do filtro e do cursor.

Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.sandbox.kodano.com.br/v1/customers/string' \  -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \  -H 'X-Correlation-Id: erp-7f3a-0010' \  -H 'Content-Type: application/json' \  -d '{  "email": "ana@novoemail.com.br",  "phone": {    "areaCode": "21",    "number": "988887777"  }}'
Example Response
{  "id": "cus_8kQ2mZ7xW1pL4nR0",  "type": "INDIVIDUAL",  "name": "Ana Souza",  "document": "12345678909",  "email": "ana@novoemail.com.br",  "phone": {    "areaCode": "21",    "number": "988887777"  },  "address": {    "postalCode": "01310100",    "publicArea": "Av. Paulista",    "number": "1000",    "complement": "Conj. 101",    "neighborhood": "Bela Vista",    "city": "São Paulo",    "state": "SP"  },  "createdAt": "2026-10-16T13:00:00Z",  "updatedAt": "2026-10-16T15:42:10Z"}