Pular para o conteúdo principal

Gravações

PATCH

  • /integrations/records

Atualiza os dados das gravações.

Authorization

  • Authorization: Bearer <application_token>

Parâmetros

  • filters: Filtro que indentifica a gravação no sistema.
  • labels: Labels que serão aplicadas nas gravações

Os parâmetros do body da requisição tem o seguinte formato:

Array<{
filters: {
customId: string;
};
labels: Array<[name: string, value: string]>;
}>;

Resultado

O resultado para uma requisição bem sucedida será um 200 Ok com o seguinte formato:

{
"code": "success" | "partial" | "failed";
"message":
| "Successfully updated all records."
| "Performed partial updated due to some request errors."
| "Failed to update records.";
"updated": number;
"failed": number;
"errors": (InvalidLabelsErrors | InsertLabelsErrors)[];
}

Os tipos auxiliares abaixo facilitará o entendimento do retorno no body:

type Filters = {
customId: string;
};

type Details = {
duplicated: string[];
forbidden: string[];
missing: string[];
};

type InvalidLabelsErrors = {
index: number;
code: "invalidLabels";
details: Details;
filters: Filters;
};

type InsertLabelsErrors = {
index: number;
code: "notFound" | "notUnique";
};