Vincular esta pessoa a outra.
POST · API de Integração v2
/v2/pessoas/{id}/vinculosGrava uma linha, que passa a aparecer nas duas fichas. Em tipo direcional (simetrica: false) o papelPessoaAtual é obrigatório: sem ele não há como saber quem é o pai. Em simétrico, cadastrar pela ficha de qualquer um dos dois dá o mesmo vínculo — a segunda tentativa é 409.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de caminho1
idintegerobrigatórioID da pessoa cuja ficha está aberta.
Corpo da requisiçãoobrigatório
Dados do vínculo.
application/json
dataFimstringFim da vigência — o vínculo terminou de verdade (divórcio). Para cadastro errado, use DELETE.
dataIniciostringInício da vigência.
observacaostringObservação livre.
papelPessoaAtualstringQual lado a pessoa da URL ocupa. Obrigatório quando o tipo tem simetrica: false — sem ele não há como saber quem é o pai e quem é o filho. Ignorado em tipo simétrico.
pessoaRelacionadaIdintegerobrigatórioID da outra pessoa. Ids de GET /v2/pessoas/opcoes.
tipoRelacaoIdintegerobrigatórioID do tipo. Ids de GET /v2/pessoas/vinculos/tipos.
Respostas5
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.
Corpo não especificado no contrato
O contrato não especifica o corpo desta resposta.
Contrato de respostas
200Vínculo criado ou reativado.
Vínculo criado ou reativado.
O contrato não declara um corpo para esta resposta.
400Auto-vínculo, período invertido, tipo inválido, `papelPessoaAtual` ausente em tipo direcional, ou pessoa relacionada fora do escri
Auto-vínculo, período invertido, tipo inválido, papelPessoaAtual ausente em tipo direcional, ou pessoa relacionada fora do escritório.
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.
404Pessoa da URL não encontrada neste escritório.
Pessoa da URL não encontrada neste escritório.
O contrato não declara um corpo para esta resposta.
409`vinculo_ja_existe` — a relação já está cadastrada; ou `vinculo_inverso_existente` — o sentido contrário já existe num tipo que nã
vinculo_ja_existe — a relação já está cadastrada; ou vinculo_inverso_existente — o sentido contrário já existe num tipo que não admite os dois.
O contrato não declara um corpo para esta resposta.