Pessoas

Editar período e observação de um vínculo.

PATCH · API de Integração v2

PATCH/v2/pessoas/{id}/vinculos/{vinculoId}

Só isso é editável. Trocar tipo ou pessoas seria outro vínculo — remova e crie, para passar pelas validações de simetria e de sentido contrário. Substituição integral: campo omitido é limpo.

Autenticação

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

Parâmetros de caminho2

idintegerobrigatório

ID da pessoa.

exemplo: 10

vinculoIdintegerobrigatório

ID do vínculo.

exemplo: 44

Corpo da requisiçãoobrigatório

Período e observação.

application/json

dataFimstring

Fim da vigência; omitir limpa.

exemplo: 2026-01-30

dataIniciostring

Início da vigência; omitir limpa.

exemplo: 2020-03-15

observacaostring

Observação livre; omitir limpa.

até 2000 caracteres

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

200OK

OK

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

204Vínculo atualizado.

Vínculo atualizado.

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

400Data de fim anterior à de início.

Data de fim anterior à de início.

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.

404Vínculo inexistente, removido, ou de outro escritório.

Vínculo inexistente, removido, ou de outro escritório.

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

curl --request PATCH \
  --url 'https://api.expedit.com.br/v2/pessoas/10/vinculos/44' \
  --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.

Corpo não especificado no contrato

O contrato não especifica o corpo desta resposta.

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