Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
customers

Cadastra um novo cliente.

Utilize esta função para criar novos clientes na plataforma. Cliente é uma das entidades básicas do sistema. Ele representa a pessoa física ou jurídica que possui uma ou mais assinaturas.

Código da API

Quando utilizado, o campo code deve ser único em todo escopo da empresa. Recomendamos o uso de um código auto-incrementável do seu próprio banco de dados. Desaconselhamos a utilização de qualquer dado que seja informado pelo cliente, como e-mail ou número do documento.

post/v1/customers

Request body

bodystring

JSON com atributos do novo 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

metadata'array'

Metadados do cliente

Response

Cliente cadastrado 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