client.expertBanList.addExperts()

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const expertChangeResult = await client.expertBanList.addExperts({
  projectId: "pp.019a0000-0000-7000-8000-000000000001",
  expertIds: [
    "example"
  ],
  reason: "example"
});
console.log(expertChangeResult);

{
  "changedCount": 0
}

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const expertChangeResult = await client.expertBanList.addExperts({
  projectId: "pp.019a0000-0000-7000-8000-000000000001",
  expertIds: [
    "example"
  ],
  reason: "example"
});
console.log(expertChangeResult);

{
  "changedCount": 0
}

Ban experts so they cannot be invited to the project and are removed from the work they are already in. The request is rejected when any of the experts is already banned.

Signature

Method signature on client.expertBanList:

addExperts(args: {
  projectId: string;
  expertIds: string[];
  reason: string;
}): Promise<ExpertChangeResult>;

Parameters

string

required

Project ID with prefix pp..

string[]

required

IDs of the experts to ban.

string

required

Why the experts are banned; applied to every expert in the request.

Returns

Promise<ExpertChangeResult>

number

required

Number of experts added or removed.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses:

Status	Description
404	Project or expert list not found, or not available for it
429	Rate limit exceeded

HTTP endpoint: POST /projects/{projectId}/expert-ban-list/experts/add.

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const expertChangeResult = await client.expertBanList.addExperts({
  projectId: "pp.019a0000-0000-7000-8000-000000000001",
  expertIds: [
    "example"
  ],
  reason: "example"
});
console.log(expertChangeResult);

{
  "changedCount": 0
}

Reference

TypeScript SDK

CLI

HTTP API

client.expertBanList.addExperts()

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors