PUT
Atualizar contato

Authorizations

Authorization
string
header
required

HTTP Basic com o token como usuário e o secret como senha: curl -u dpz_tk_…:dpz_sk_…. Crie a chave em https://despezzas.com/settings/api-keys.

Path Parameters

id
string
required

Identificador do recurso.

Example:

"8f1c2a34-5b6d-4e7f-8a9b-0c1d2e3f4a5b"

Body

application/json

Todos opcionais: só o que for enviado é alterado.

address_city
string | null

Cidade.

Example:

null

address_complement
string | null

Complemento.

Example:

null

address_district
string | null

Bairro.

Example:

null

address_number
string | null

Número.

Example:

null

address_state
string | null

UF.

Example:

null

address_street
string | null

Logradouro.

Example:

null

address_zip
string | null

CEP.

Example:

null

city_code
string | null

Código IBGE do município (NFS-e).

Example:

null

document
string | null

CPF ou CNPJ (com ou sem máscara).

Example:

"12.345.678/0001-90"

email
string | null

E-mail.

Example:

"contato@alfa.com.br"

municipal_inscription
string | null

Inscrição municipal (NFS-e).

Example:

null

name
string

Nome.

Example:

"Distribuidora Alfa"

notes
string | null

Observações.

Example:

null

phone
string | null

Telefone.

Example:

"1133334444"

type
enum<string>

Tipo. Padrão: supplier.

Available options:
customer,
supplier,
both,
partner
Example:

"supplier"

Response

Sucesso.

created_by_user_id
string
required

Quem cadastrou.

Example:

"0d6b923c-3392-424e-a152-2ee32474e8d5"

id
string
required

Id do contato.

Example:

"f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b"

name
string
required

Nome.

Example:

"Distribuidora Alfa"

type
enum<string>
required

Tipo.

Available options:
customer,
supplier,
both,
partner
Example:

"supplier"

address_city
string | null

Cidade.

Example:

null

address_complement
string | null

Complemento.

Example:

null

address_district
string | null

Bairro.

Example:

null

address_number
string | null

Número.

Example:

null

address_state
string | null

UF.

Example:

null

address_street
string | null

Logradouro.

Example:

null

address_zip
string | null

CEP.

Example:

null

city_code
string | null

Código IBGE do município (NFS-e).

Example:

null

createdAt
string<date-time>

Criação.

Example:

"2026-09-01T09:00:00.000Z"

document
string | null

CPF/CNPJ (só dígitos).

Example:

"12345678000190"

document_type
enum<string> | null

Tipo do documento (derivado).

Available options:
cpf,
cnpj,
null
Example:

"cnpj"

email
string | null

E-mail.

Example:

"contato@alfa.com.br"

municipal_inscription
string | null

Inscrição municipal (NFS-e).

Example:

null

notes
string | null

Observações.

Example:

null

phone
string | null

Telefone.

Example:

"1133334444"

profile_id
string | null

Empresa (perfil de acesso).

Example:

"5b2c1e0a-7d3f-4c8e-9a1b-2f6d8e4c7a90"

updatedAt
string<date-time>

Última alteração.

Example:

"2026-09-15T14:32:10.000Z"

user_id
string | null

Dono (contexto pessoal).

Example:

null