Endpoint

Alterar cliente

PATCH/api/v1/{escritorio}/clientes/{codigo}

Altera um ou mais campos da ficha. É tudo ou nada: se um campo for inválido, responde 400 com campos e nada é gravado. Senhas e o usuário do portal não entram pela API, nem os campos personalizados do tipo senha. CPF ou CNPJ que já está em outro cliente do escritório: 409 CPF_EM_USO ou CNPJ_EM_USO, e nada é gravado.

Permissão exigida

Ficha do cliente: Alterar, com Atendimento: Acessar ou processo do cliente no alcance

Só leitura recusa com 403

Parâmetros de caminho

escritoriotextoobrigatório
Código do escritório, com 5 dígitos. Os escritórios em que o token vale estão em GET /api/v1/eu.
codigotextoobrigatório
Código do cliente, como EX-0001.

Corpo

tipotexto ou nulo
Tipo
areaIdtexto ou nulo
Área de atuação
descricaotexto ou nulo
Descrição comercial
nometexto ou nulo
Nome completo
cpftexto ou nulo
CPF
rgtexto ou nulo
RG
nascimentotexto ou nulo
Data de nascimento (AAAA-MM-DD).
estadoCiviltexto ou nulo
Estado civil
sexotexto ou nulo
Sexo
profissaotexto ou nulo
Profissão
menorIncapazverdadeiro ou falso
Menor/Incapaz
respLegalNometexto ou nulo
Responsável legal
respLegalCpftexto ou nulo
CPF do responsável legal
razaoSocialtexto ou nulo
Razão social
nomeFantasiatexto ou nulo
Nome fantasia
cnpjtexto ou nulo
CNPJ
inicioAtividadestexto ou nulo
Data de início (AAAA-MM-DD).
celulartexto ou nulo
Celular
emailtexto ou nulo
E-mail
ceptexto ou nulo
CEP
ruatexto ou nulo
Rua
numerotexto ou nulo
Número
complementotexto ou nulo
Complemento
bairrotexto ou nulo
Bairro
cidadetexto ou nulo
Cidade
uftexto ou nulo
Estado
camposPersonalizadoslista de objetos
Campos personalizados do Atendimento e da área do cliente, exceto os de senha.
- campoIdtexto (UUID)obrigatório
  Identificador do campo personalizado.
- valortexto ou nuloobrigatório
  Valor; nulo ou vazio apaga.

Testar

Exemplo

cURL

curl -X PATCH "https://developer.jur.ia2s.com.br/api/v1/10345/clientes/SEU_CODIGO" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "maria.oliveira@exemplo.com.br"
}'

Node

// Node 18 ou mais novo, em um arquivo .mjs
const resposta = await fetch("https://developer.jur.ia2s.com.br/api/v1/10345/clientes/SEU_CODIGO", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer SEU_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "maria.oliveira@exemplo.com.br"
  }),
});
console.log(resposta.status, await resposta.json());

Python

import requests

resposta = requests.patch(
    "https://developer.jur.ia2s.com.br/api/v1/10345/clientes/SEU_CODIGO",
    headers={"Authorization": "Bearer SEU_TOKEN"},
    json={
        "email": "maria.oliveira@exemplo.com.br",
    },
)
print(resposta.status_code)
print(resposta.json())

Respostas

200

Sucesso.

{
  "codigo": "EX-0001",
  "tipo": "PF",
  "nomeExibicao": "Maria Oliveira",
  "areaId": "0190a000-0000-7000-8000-000000000002",
  "descricao": "Quer revisar a aposentadoria.",
  "nome": "Maria Oliveira",
  "cpf": null,
  "rg": null,
  "nascimento": "1970-05-20",
  "estadoCivil": "Casado(a)",
  "sexo": null,
  "profissao": null,
  "menorIncapaz": false,
  "respLegalNome": null,
  "respLegalCpf": null,
  "razaoSocial": null,
  "nomeFantasia": null,
  "cnpj": null,
  "inicioAtividades": null,
  "celular": "11900000000",
  "email": "maria@exemplo.com.br",
  "cep": null,
  "rua": null,
  "numero": null,
  "complemento": null,
  "bairro": null,
  "cidade": "São Paulo",
  "uf": "SP",
  "statusId": "0190a000-0000-7000-8000-000000000001",
  "statusEm": "2026-11-06T12:00:00.000Z",
  "contratoEm": null,
  "criadoEm": "2026-11-06T12:00:00.000Z",
  "atualizadoEm": "2026-11-06T12:00:00.000Z",
  "parceiro": {
    "indicado": false,
    "parceiroId": null,
    "valor": null,
    "nome": null
  },
  "etiquetas": [],
  "responsaveisPJ": [],
  "camposPersonalizados": [
    {
      "campoId": "0190a000-0000-7000-8000-000000000001",
      "nome": "Origem do contato",
      "tipo": "TEXTO",
      "valor": "Indicação"
    }
  ]
}

Campos da resposta

codigotextoobrigatório
tipotextoobrigatório
Valores: PFPJ
nomeExibicaotextoobrigatório
Nome, ou razão social na pessoa jurídica.
areaIdtexto ou nuloobrigatório
Área de atuação (departamento).
descricaotexto ou nuloobrigatório
nometexto ou nuloobrigatório
cpftexto ou nuloobrigatório
rgtexto ou nuloobrigatório
nascimentotexto ou nuloobrigatório
AAAA-MM-DD.
estadoCiviltexto ou nuloobrigatório
sexotexto ou nuloobrigatório
profissaotexto ou nuloobrigatório
menorIncapazverdadeiro ou falsoobrigatório
respLegalNometexto ou nuloobrigatório
respLegalCpftexto ou nuloobrigatório
razaoSocialtexto ou nuloobrigatório
nomeFantasiatexto ou nuloobrigatório
cnpjtexto ou nuloobrigatório
inicioAtividadestexto ou nuloobrigatório
AAAA-MM-DD.
celulartexto ou nuloobrigatório
emailtexto ou nuloobrigatório
ceptexto ou nuloobrigatório
ruatexto ou nuloobrigatório
numerotexto ou nuloobrigatório
complementotexto ou nuloobrigatório
bairrotexto ou nuloobrigatório
cidadetexto ou nuloobrigatório
uftexto ou nuloobrigatório
statusIdtextoobrigatório
Status do Atendimento.
statusEmtextoobrigatório
contratoEmtexto ou nuloobrigatório
Quando virou cliente; nulo enquanto é lead.
criadoEmtextoobrigatório
atualizadoEmtextoobrigatório
parceiroobjetoobrigatório
- indicadoverdadeiro ou falsoobrigatório
- parceiroIdtexto ou nuloobrigatório
- valortexto ou nuloobrigatório
  Valor da indicação, em string decimal.
- nometexto ou nuloobrigatório
  Nome do parceiro indicado.
etiquetaslista de textosobrigatório
Identificadores das etiquetas.
responsaveisPJlista de objetosobrigatório
- idtextoobrigatório
- nometextoobrigatório
- cpftexto ou nuloobrigatório
- cargotexto ou nuloobrigatório
camposPersonalizadoslista de objetosobrigatório
Os campos personalizados com valor. Os do tipo senha nunca saem.
- campoIdtextoobrigatório
- nometextoobrigatório
- tipotextoobrigatório
  Valores: TEXTODATANUMEROSELECAO
- valortexto ou nuloobrigatório

400

Corpo ou parâmetro inválido.

INVALIDO

{
  "codigo": "INVALIDO",
  "mensagem": "Confira os dados informados.",
  "campos": {
    "departamentoId": "Valor inválido."
  }
}

CHAVE_IDEMPOTENCIA_INVALIDA

{
  "codigo": "CHAVE_IDEMPOTENCIA_INVALIDA",
  "mensagem": "A Idempotency-Key deve ter de 1 a 255 caracteres visíveis, sem espaços."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

401

Sem token, ou token revogado ou expirado, ou pessoa desativada.

TOKEN_INVALIDO

{
  "codigo": "TOKEN_INVALIDO",
  "mensagem": "Token de API inválido, expirado ou revogado."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

403

A pessoa não pode fazer isto, o token é só de leitura, foi bloqueado neste escritório, não tem esta operação, quem o gerou saiu do escritório ou o acesso ao escritório está suspenso.

SEM_PERMISSAO

{
  "codigo": "SEM_PERMISSAO",
  "mensagem": "Sem permissão para esta alteração."
}

TOKEN_SO_LEITURA

{
  "codigo": "TOKEN_SO_LEITURA",
  "mensagem": "Este token é só de leitura."
}

TOKEN_SEM_ESCOPO

{
  "codigo": "TOKEN_SEM_ESCOPO",
  "mensagem": "Este token não tem permissão para esta operação."
}

TOKEN_BLOQUEADO

{
  "codigo": "TOKEN_BLOQUEADO",
  "mensagem": "Este token foi bloqueado pela administração deste escritório."
}

TOKEN_AUTOR_INATIVO

{
  "codigo": "TOKEN_AUTOR_INATIVO",
  "mensagem": "Quem gerou este token não está mais ativo neste escritório."
}

ESCRITORIO_SUSPENSO

{
  "codigo": "ESCRITORIO_SUSPENSO",
  "mensagem": "O acesso a este escritório está suspenso. Fale com a IA2S."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

404

Não existe, está fora do alcance da pessoa, ou o escritório do caminho não é dela.

NAO_ENCONTRADO

{
  "codigo": "NAO_ENCONTRADO",
  "mensagem": "Não encontrado."
}

ESCRITORIO_NAO_ENCONTRADO

{
  "codigo": "ESCRITORIO_NAO_ENCONTRADO",
  "mensagem": "Escritório não encontrado."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

409

Conflito: veja o campo `codigo`.

TENTE_NOVAMENTE

{
  "codigo": "TENTE_NOVAMENTE",
  "mensagem": "Outra pessoa alterou isto ao mesmo tempo. Tente novamente."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

413

Corpo da requisição grande demais.

CORPO_GRANDE

{
  "codigo": "CORPO_GRANDE",
  "mensagem": "O corpo da requisição é grande demais."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

429

Limite de 120 requisições por minuto.

Cabeçalho Retry-After: Segundos até poder tentar de novo.

LIMITE_TOKEN

{
  "codigo": "LIMITE_TOKEN",
  "mensagem": "Muitas requisições com este token. Tente de novo em um minuto."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

503

O sistema está ocupado. Tente em instantes.

SISTEMA_OCUPADO

{
  "codigo": "SISTEMA_OCUPADO",
  "mensagem": "O sistema está ocupado. Tente em instantes."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório