Pessoas

Criar um tipo do escritório.

POST · API de Integração v2

POST/v2/pessoas/tipos

O tipo nasce ativo e no escopo do escritório autenticado — não há como criar global. O nome não pode repetir outro tipo visível, incluindo os globais.

Autenticação

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

Corpo da requisiçãoobrigatório

Nome do novo tipo.

application/json

nomestringobrigatório

Nome do tipo, único entre os globais e os do escritório.

até 100 caracteresexemplo: Fornecedor

Respostas3

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 criado.

Tipo criado.

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
400Nome vazio, longo demais ou já usado por um tipo visível.

Nome vazio, longo demais ou já usado por um tipo visível.

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.

© 2026 Expedit LawtechFeito para conectar.