Pessoas

Alterar marcadores, equipes ou responsáveis em lote

POST · API de Integração v2

POST/v2/pessoas/relacionamentos-em-lote

A ação é idempotente: adicionar reativa ou mantém o vínculo e remover mantém a remoção. Alvos inválidos, inativos ou de outro escritório devolvem 400; pessoas inválidas são ignoradas no relatório.

Autenticação

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

Corpo da requisiçãoobrigatório

Pessoas, alvo, ação e IDs a relacionar.

application/json

acaostringobrigatório

valores: ADICIONAR · REMOVERexemplo: ADICIONAR

alvostringobrigatório

valores: EQUIPES · MARCADORES · RESPONSAVEISexemplo: MARCADORES

alvoIdsinteger[]obrigatório

IDs dos marcadores, equipes ou responsáveis (1..100).

exemplo: [45,46]

idsinteger[]obrigatório

IDs das pessoas (1..1000).

exemplo: [123,124]

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

{
  "ignorados": [
    {
      "id": 125,
      "motivo": "string"
    }
  ],
  "pessoasProcessadas": [
    123,
    124
  ],
  "relacionamentosSolicitados": 4,
  "solicitados": 3
}

Contrato de respostas

200Lote processado (ver pessoasProcessadas/ignorados).

Lote processado (ver pessoasProcessadas/ignorados).

application/json

ignoradosPessoaIgnoradaResponse[]

Pessoas não processadas e seus motivos

Ver propriedades

idinteger

ID da pessoa não processada

formato: int64exemplo: 125

motivostring

Motivo seguro pelo qual a pessoa foi ignorada

pessoasProcessadasinteger[]

IDs das pessoas processadas

exemplo: [123,124]

relacionamentosSolicitadosinteger

Quantidade de pares pessoa/alvo solicitados

formato: int32exemplo: 4

solicitadosinteger

Quantidade de pessoas solicitadas

formato: int32exemplo: 3

400Payload ou alvo inválido.

Payload ou alvo inválido.

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.

curl --request POST \
  --url 'https://api.expedit.com.br/v2/pessoas/relacionamentos-em-lote' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "alvoIds": [],
  "ids": []
}'

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

{
  "alvoIds": [],
  "ids": []
}

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

Exemplo · HTTP 200

{
  "ignorados": [
    {
      "id": 125,
      "motivo": "string"
    }
  ],
  "pessoasProcessadas": [
    123,
    124
  ],
  "relacionamentosSolicitados": 4,
  "solicitados": 3
}

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