Pessoas

Atualizar pessoa

PUT · API de Integração v2

PUT/v2/pessoas/{id}

Atualizar pessoa

Substitui integralmente o estado editável da pessoa: dados principais, contatos, documentos, endereço, complementos, representante, responsáveis, equipes e campos personalizados.

Limpeza explícita: campo ou bloco opcional com null limpa seu valor; representante: null remove o representante; listas vazias removem todos os vínculos daquele bloco. Por isso, envie o estado completo carregado por GET /v2/pessoas/{id}.

Exemplo de limpeza de representante e vínculos: { "nome": "João da Silva", "classificacao": "CLIENTE", "representante": null, "controleAcesso": { "responsaveisIds": [], "equipesIds": [] }, "camposPersonalizados": [] }.

A rota não altera a situação de arquivamento. Pessoas arquivadas também podem ser editadas. O escritório e o usuário atualizador vêm do token, nunca do corpo.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Parâmetros de caminho1

idintegerobrigatório

ID da pessoa.

exemplo: 863210

Corpo da requisiçãoobrigatório

Estado completo editavel da pessoa.

application/json

apelidostring

Apelido / nome curto

exemplo: João

avatarUrlstring

URL pública HTTP(S) da foto — link, sem upload

até 2048 caracteresregex: ^[hH][tT][tT][pP][sS]?://[^\s]+$exemplo: https://exemplo.com/foto.jpg

camposPersonalizadosCampoPersonalizadoRequest[]

Campos personalizados (definições com type=pessoa). Cada item referencia o campoId da definição e traz seus valores.

Ver propriedades

campoIdintegerobrigatório

ID da definição do campo (de GET /v2/campos-personalizados/opcoes?type=PESSOA)

formato: int64exemplo: 12

valoresstring[]

Valores do campo, SEMPRE como lista: 1 item para valor único (texto/número/data/seleção/escolha única/texto longo) ou vários para múltipla escolha (checkbox).

exemplo: ["Opção A","Opção C"]

classificacaostring

Deprecated — use tipoId. Só alcança os 8 tipos globais; ignorado quando tipoId vem junto.

valores: ADVOGADO · ADVOGADO_CONTRARIO · CLIENTE · COLABORADOR · CORRESPONDENTE · OUTRO · PARTE_CONTRARIA · TESTEMUNHAexemplo: CLIENTE

complementosComplementosRequest

Ver propriedades

grupoEmpresasIdinteger

ID do grupo de empresas

formato: int64

indicacaoIdinteger

ID da indicação. Legado — prefira indicacoes. Continua aceito para quem já o envia; vindo junto de indicacoes, só é aceito se apontar para a mais antiga do conjunto.

formato: int64

indicacoesIndicacaoRequest[]

Indicações da pessoa, cada uma com observação própria. Sem ordem e sem principal — a lista é exibida inteira.

Ver propriedades

indicacaoIdintegerobrigatório

ID da indicação. Ids de GET /v2/indicacoes.

formato: int64exemplo: 42

obsstring

Observação sobre esta indicação

até 255 caracteresexemplo: Indicou na audiência de conciliação

observacoesstring

Observações

valorHoranumber

Valor da hora

exemplo: 250

contatosContatosRequest

Ver propriedades

emailstring

E-mail

exemplo: joao@exemplo.com

facebookstring

Perfil do Facebook

instagramstring

Perfil do Instagram

linkedinstring

Perfil do LinkedIn

sitestring

Site

telefone03string

Terceiro telefone

telefonePrincipalstring

Telefone principal

exemplo: (81) 99999-9999

telefoneSecundariostring

Telefone secundário

controleAcessoControleAcessoRequest

Ver propriedades

equipesIdsinteger[]

IDs das equipes. Ids de /v2/equipes/opcoes.

exemplo: [406]

responsaveisIdsinteger[]

IDs dos responsáveis. Ids de /v2/usuarios/opcoes.

exemplo: [1649]

cpfCnpjstring

CPF ou CNPJ (com ou sem máscara)

exemplo: 000.000.000-00

documentosDocumentosRequest

Ver propriedades

cidstring

CID

ctpsstring

CTPS

dataEmissaoRgstring

Data de emissão do RG

dataNascimentostring

Data de nascimento

exemplo: 1990-01-31

estadoCivilstring

Estado civil

nacionalidadestring

Nacionalidade

naturalidadestring

Naturalidade

nomeMaestring

Nome da mãe

nomePaistring

Nome do pai

orgaoEmissorRgstring

Órgão emissor do RG

pisstring

PIS

profissaostring

Profissão

rgstring

sexostring

Sexo

enderecoEnderecoRequest

Ver propriedades

bairrostring

Bairro

cepstring

CEP

exemplo: 50000-000

cidadestring

Cidade

complementostring

Complemento

estadostring

UF (duas letras)

até 2 caracteresregex: ^[a-zA-Z]{2}$exemplo: PE

logradourostring

Logradouro

numerostring

Número

naturezaPessoastring

Natureza da pessoa; null limpa o valor

valores: FISICA · JURIDICAexemplo: FISICA

nomestringobrigatório

Nome da pessoa

exemplo: João da Silva

oabstring

Número da OAB

representanteRepresentanteRequest

Ver propriedades

bairrostring

Bairro do representante

cepstring

CEP do representante

cidadestring

Cidade do representante

documentostring

Documento do representante (livre, sem validação de formato no v1)

enderecostring

Endereço do representante (string única, sem separar número/complemento)

estadostring

Estado (UF) do representante, duas letras

até 2 caracteresregex: ^[a-zA-Z]{2}$exemplo: PE

nascimentostring

Data de nascimento do representante

nomestringobrigatório

Nome do representante

rgstring

RG do representante

tipoIdinteger

ID do tipo de pessoa. Use os ids de GET /v2/pessoas/tipos. Obrigatório, salvo se classificacao vier no lugar.

formato: int64exemplo: 12

Respostas4

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo declarado no OpenAPI · application/json

Exemplo · HTTP 200

{
  "id": 863210,
  "nome": "João da Silva",
  "apelido": "João",
  "classificacao": "CLIENTE",
  "naturezaPessoa": "FISICA",
  "cpfCnpj": "00000000000",
  "oab": null,
  "avatarUrl": null,
  "contatos": {
    "telefonePrincipal": "81999990000",
    "email": "joao@exemplo.com"
  },
  "documentos": {
    "dataNascimento": "1990-05-20"
  },
  "endereco": {
    "cidade": "Recife",
    "estado": "PE"
  },
  "complementos": {
    "valorHora": 250
  },
  "representante": null,
  "controleAcesso": {
    "responsaveisIds": [
      1649
    ],
    "equipesIds": [
      406
    ]
  },
  "camposPersonalizados": [
    {
      "campoId": 12,
      "valores": [
        "João da Silva"
      ]
    },
    {
      "campoId": 21,
      "valores": [
        "Opção A",
        "Opção C"
      ]
    }
  ]
}

Contrato de respostas

200Pessoa atualizada.

Pessoa atualizada.

application/json

apelidostring

Apelido ou nome curto

exemplo: João

avatarUrlstring

URL do avatar

camposPersonalizadosCampoPersonalizadoResponse[]

Campos personalizados gravados

Ver propriedades

campoIdinteger

ID da definição do campo personalizado

formato: int64exemplo: 12

valoresstring[]

Valores gravados para o campo

exemplo: ["Opção A"]

classificacaostring

Deprecated — use tipoNome para exibir e tipoId para identificar. Só é preenchido nos 8 tipos globais; tipo do escritório vem null.

exemplo: CLIENTE

complementosComplementosResponse

Ver propriedades

grupoEmpresasIdinteger

ID do grupo de empresas

formato: int64

indicacaoIdinteger

ID da indicação. Legado — use indicacoes. É a projeção da mais antiga do conjunto: quem tem três indicações aparece aqui com uma só.

formato: int64

indicacoesIndicacaoResponse[]

Indicações da pessoa, da mais antiga para a mais recente.

Ver propriedades

indicacaoIdinteger

ID da indicação

formato: int64exemplo: 42

obsstring

Observação sobre esta indicação

observacoesstring

Observações

valorHoranumber

Valor da hora

exemplo: 250

contatosContatosResponse

Ver propriedades

emailstring

E-mail

exemplo: joao@exemplo.com

facebookstring

Perfil do Facebook

instagramstring

Perfil do Instagram

linkedinstring

Perfil do LinkedIn

sitestring

Site

telefone03string

Terceiro telefone

telefonePrincipalstring

Telefone principal

exemplo: (81) 99999-9999

telefoneSecundariostring

Telefone secundário

controleAcessoControleAcessoResponse

Ver propriedades

equipesIdsinteger[]

IDs das equipes vinculadas

exemplo: [406]

responsaveisIdsinteger[]

IDs dos responsáveis vinculados

exemplo: [1649]

cpfCnpjstring

CPF ou CNPJ informado

exemplo: 000.000.000-00

documentosDocumentosResponse

Ver propriedades

cidstring

CID

ctpsstring

CTPS

dataEmissaoRgstring

Data de emissão do RG

dataNascimentostring

Data de nascimento

exemplo: 1990-01-31

estadoCivilstring

Estado civil

nacionalidadestring

Nacionalidade

naturalidadestring

Naturalidade

nomeMaestring

Nome da mãe

nomePaistring

Nome do pai

orgaoEmissorRgstring

Órgão emissor do RG

pisstring

PIS

profissaostring

Profissão

rgstring

sexostring

Sexo

enderecoEnderecoResponse

Ver propriedades

bairrostring

Bairro

cepstring

CEP

exemplo: 50000-000

cidadestring

Cidade

complementostring

Complemento

estadostring

exemplo: PE

logradourostring

Logradouro

numerostring

Número

idinteger

Identificador da pessoa

formato: int64exemplo: 123

naturezaPessoastring

Natureza da pessoa

exemplo: FISICA

nomestring

Nome da pessoa

exemplo: João da Silva

oabstring

Número da OAB

representanteRepresentanteResponse

Ver propriedades

bairrostring

Bairro do representante

cepstring

CEP do representante

cidadestring

Cidade do representante

documentostring

Documento do representante

enderecostring

Endereço do representante

estadostring

UF do representante

exemplo: PE

nascimentostring

Data de nascimento do representante

exemplo: 1990-01-31

nomestring

Nome do representante

rgstring

RG do representante

tipoIdinteger

ID do tipo no catálogo (GET /v2/pessoas/tipos)

formato: int64exemplo: 12

tipoNomestring

Nome do tipo, para exibir

exemplo: Curador

400Payload ou ID invalido.

Payload ou ID invalido.

O contrato não declara um corpo para esta resposta.

401Nao autenticado (token ausente/invalido).

Nao autenticado (token ausente/invalido).

O contrato não declara um corpo para esta resposta.

404Pessoa nao encontrada.

Pessoa nao encontrada.

O contrato não declara um corpo para esta resposta.

curl --request PUT \
  --url 'https://api.expedit.com.br/v2/pessoas/863210' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

Requisição e resposta

As chamadas são enviadas diretamente à API. O domínio deste portal precisa estar autorizado no CORS.

Ver JSON gerado

Corpo gerado dos campos

{}

A resposta aparecerá aquiPreencha os campos e envie a requisição para consultar o retorno da API.

Explorar exemplos de resposta

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece: A operação foi concluída.
Como tratar: Leia os dados retornados; em listagens, confira também a paginação.

Exemplo declarado no OpenAPI · application/json

Exemplo · HTTP 200

{
  "id": 863210,
  "nome": "João da Silva",
  "apelido": "João",
  "classificacao": "CLIENTE",
  "naturezaPessoa": "FISICA",
  "cpfCnpj": "00000000000",
  "oab": null,
  "avatarUrl": null,
  "contatos": {
    "telefonePrincipal": "81999990000",
    "email": "joao@exemplo.com"
  },
  "documentos": {
    "dataNascimento": "1990-05-20"
  },
  "endereco": {
    "cidade": "Recife",
    "estado": "PE"
  },
  "complementos": {
    "valorHora": 250
  },
  "representante": null,
  "controleAcesso": {
    "responsaveisIds": [
      1649
    ],
    "equipesIds": [
      406
    ]
  },
  "camposPersonalizados": [
    {
      "campoId": 12,
      "valores": [
        "João da Silva"
      ]
    },
    {
      "campoId": 21,
      "valores": [
        "Opção A",
        "Opção C"
      ]
    }
  ]
}

Exemplos e campos gerados do contrato OpenAPI. Revise os valores antes de integrar.