Atualizar parcialmente uma pessoa por id

Pessoas

Atualizar parcialmente uma pessoa por id

Request

Permite atualizar parcialmente o cadastro de uma pessoa existente (por exemplo: alterar email, telefone, tipo de perfil ou endereço) identificada por id. Essa abordagem garante menor impacto e maior controle na atualização dos dados.

Security

BearerAuth

Path

idstringrequired

ID da pessoa a ser atualizada

Bodyapplication/jsonrequired

Dados da pessoa a serem atualizados

agencia_publicaboolean

Indica se a pessoa é uma agência pública

Example:true

ativoboolean

Indica se a pessoa está ativa

Example:true

cnpjstring

CNPJ da pessoa jurídica

Example:"12.345.678/0001-90"

codigostring

Código da pessoa

Example:"CLI001"

contato_cobranca_faturamentoobject(AtualizacaoContatoCobrancaFaturamento)

Contato de cobrança e faturamento

cpfstring

CPF da pessoa física

Example:"123.456.789-00"

data_nascimentostring

Data de nascimento da pessoa física

Example:"1990-01-01"

emailstring

Emails da pessoa separados por vírgula

Example:"joao.silva@email.com, maria.silva@email.com"

enderecosArray of objects(EnderecoAtualizacaoParcial)

Lista de endereços

inscricoesArray of objects(InscricaoAtualizacaoParcial)

Lista de inscrições estaduais e municipais

nomestring

Nome da pessoa

Example:"João Silva"

nome_empresastring

Nome fantasia da pessoa jurídica

Example:"Empresa LTDA"

observacaostring

Observações sobre a pessoa

Example:"Cliente preferencial"

optante_simples_nacionalboolean

Indica se a pessoa é optante pelo Simples Nacional

Example:true

perfisArray of objects(AtualizacaoTipoPerfil)

Lista de perfis associados à pessoa

rgstring

Registro Geral (RG) da pessoa. Para pessoas estrangeiras, este campo representa o identificador estrangeiro.

Example:"12.345.678-9"

telefone_celularstring

Telefone celular

Example:"11987654321"

telefone_comercialstring

Telefone comercial da pessoa

Example:"1112345678"

tipo_pessoastring(TipoPessoa)

Tipo de pessoa: Física, Jurídica ou Estrangeira

Enum:"Física""Jurídica""Estrangeira"

Example:"Física"

curl -i -X PATCH \
  'https://api-v2.contaazul.com/v1/pessoas/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "agencia_publica": true,
    "ativo": true,
    "cnpj": "12.345.678/0001-90",
    "codigo": "CLI001",
    "contato_cobranca_faturamento": {
      "emails": [
        "carlos.oliveira@email.com",
        "joao.silva@email.com"
      ],
      "whatsapp": "5511999999999"
    },
    "cpf": "123.456.789-00",
    "data_nascimento": "1990-01-01",
    "email": "joao.silva@email.com, maria.silva@email.com",
    "enderecos": [
      {
        "bairro": "Centro",
        "cep": "12345-678",
        "cidade": "São Paulo",
        "complemento": "Apto 45",
        "estado": "SP",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "logradouro": "Rua das Flores",
        "numero": "123",
        "pais": "Brasil"
      }
    ],
    "inscricoes": [
      {
        "indicador_inscricao_estadual": "NAO CONTRIBUINTE",
        "inscricao_estadual": "123456789",
        "inscricao_municipal": "123456789",
        "inscricao_suframa": "123456789"
      }
    ],
    "nome": "João Silva",
    "nome_empresa": "Empresa LTDA",
    "observacao": "Cliente preferencial",
    "optante_simples_nacional": true,
    "perfis": [
      {
        "tipo_perfil": "Cliente"
      }
    ],
    "rg": "12.345.678-9",
    "telefone_celular": "11987654321",
    "telefone_comercial": "1112345678",
    "tipo_pessoa": "Física"
  }'

Responses

No Content

Response

No content