Pessoas

Renomear e/ou reativar um tipo do escritório.

PATCH · API de Integração v2

PATCH/v2/pessoas/tipos/{id}

Campos independentes: omitir um mantém o valor atual. ativo: true traz de volta um tipo desativado — sem isso o nome dele ficaria bloqueado para sempre pelo índice único.

Autenticação

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

Parâmetros de caminho1

idintegerobrigatório

ID do tipo.

exemplo: 12

Corpo da requisiçãoobrigatório

Campos a alterar.

application/json

ativoboolean

Reativa (true) ou desativa (false) o tipo. Omitir para manter.

exemplo: true
nomestring

Novo nome. Omitir para manter o atual.

até 100 caracteresexemplo: Fornecedor

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 ilustrativo gerado do schema · application/json

Exemplo · HTTP 200
{
  "ativo": true,
  "global": false,
  "id": 12,
  "nome": "Fornecedor"
}

Contrato de respostas

200Tipo atualizado.

Tipo atualizado.

application/json

ativoboolean

false para tipo desativado: some das novas seleções, mas segue válido em quem já o usa.

exemplo: true
globalboolean

true para tipo padrão do sistema — visível a todos e somente leitura.

exemplo: false
idinteger

ID do tipo, usado como tipoId no cadastro de pessoa.

formato: int64exemplo: 12
nomestring

Nome exibido.

exemplo: Fornecedor
400Nenhum campo informado, ou nome inválido/repetido.

Nenhum campo informado, ou nome inválido/repetido.

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

401Não autenticado (token ausente/inválido).

Não autenticado (token ausente/inválido).

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

404Tipo inexistente, de outro escritório, ou global (somente leitura).

Tipo inexistente, de outro escritório, ou global (somente leitura).

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

© 2026 Expedit LawtechFeito para conectar.