cronotaDocumentação da API

/customers/{id}

Mande só os campos que mudam. O endereço vai em address; incompleto, é recusado com o campo que falta.

Server URLhttps://cronota.clowk.in/api/v1
PATCH/customers/{id}

Autorização

Bearer token: sk_live_… (Live) ou sk_test_… (Sandbox). A chave define a empresa e o ambiente.

Parâmetros

idstring · pathobrigatório

O id do recurso.

Request body

application/json, obrigatório

document_typestringopcional

Sem ele, deduzido do documento (11 dígitos CPF, 14 CNPJ).

Um de cnpj, cpf, nif, none
documentstringopcional
namestringopcional
emailstringopcional

Vários separados por vírgula.

Formato email
phonestringopcional
addressobjectopcional

No Brasil: zipcode, street, number, neighborhood, municipality_code (IBGE, 7 dígitos), city, state. No exterior: country, street, postal_code, city, region.

zipcodestringopcional
streetstringopcional
numberstringopcional
complementstringopcional
neighborhoodstringopcional
municipality_codestringopcional
citystringopcional
statestringopcional
countrystringopcional
postal_codestringopcional
regionstringopcional

Respostas

200O tomador.
idstringopcional
Formato uuid
objectstringopcional
document_typestringopcional
Um de cnpj, cpf, nif, none
documentstringopcional
namestringopcional
emailstring | nullopcional
Formato email
phonestring | nullopcional
addressobjectopcional

No Brasil: zipcode, street, number, neighborhood, municipality_code (IBGE, 7 dígitos), city, state. No exterior: country, street, postal_code, city, region.

zipcodestringopcional
streetstringopcional
numberstringopcional
complementstringopcional
neighborhoodstringopcional
municipality_codestringopcional
citystringopcional
statestringopcional
countrystringopcional
postal_codestringopcional
regionstringopcional
created_atstringopcional
Formato date-time
updated_atstringopcional
Formato date-time
404Não existe nesta empresa e ambiente.
errorobjectopcional
codestringopcional

Estável, para o seu código decidir.

messagestringopcional

Para pessoas, em português.

fieldsobjectopcional

Nos 422 de validação: as mensagens de cada campo, com os nomes que a API recebe (como address.street).

422Não passou nas validações: `fields` diz o que falta em cada campo.
errorobjectopcional
codestringopcional

Estável, para o seu código decidir.

messagestringopcional

Para pessoas, em português.

fieldsobjectopcional

Nos 422 de validação: as mensagens de cada campo, com os nomes que a API recebe (como address.street).