Add entry to blacklist

POST/api/crm/v2/black_list.addv2

operationId: blackList.add

Adds an entry to the blacklist. type_lock specifies which identifier is expected in the request body: phone_number, client_branch_profile_id, or client_account_id. Duplicates within the network are rejected.

Authorization

api-token + language + role

Request body `application/json`

object

type_lockstringrequired

Values:phone_numberclient_branch_profile_idclient_account_id

Example: phone_number

One of the options

object (blackListOneOf)

Request body for network

One of the options

object

Blocked by phone_number

phone_format_idinteger (PhoneFormatId) required

Country code: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Example: 1

phone_numberstringrequired

Example: 705-712-51-20

object

Blocking by client_branch_profile_id

client_branch_profile_idintegerrequired

Client profile ID in branch

Example: 48997963

object

Blocked by client_account_id

client_account_idintegerrequired

Client account ID

Example: 4211309

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

descriptionstring

Example: Successfully added

rowobject

chain_idinteger

Example: 7135

datestring (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

phone_format_idinteger

Example: 4

phone_numberstring

Example: 7057125119

client_account_idinteger

Example: 0

client_branch_profile_idinteger

Example: 0

blockedboolean

Example: true

idstring

Example: 82348

curl -X POST 'https://foodsoul.ru/api/crm/v2/black_list.add' \ -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \ -H 'language: en' \ -H 'role: partner' \ -H 'Content-Type: application/json' \ -d '{"phone_format_id":1,"phone_number":"705-712-51-20"}'

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/black_list.add', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'en', 'role' => 'partner', ], 'json' => [ 'phone_format_id' => 1, 'phone_number' => '705-712-51-20', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/black_list.add", { method: "POST", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "en", "role": "partner", "Content-Type": "application/json" }, body: JSON.stringify({ "phone_format_id": 1, "phone_number": "705-712-51-20" }), }) const data = await response.json()

import requests response = requests.request( "POST", "https://foodsoul.ru/api/crm/v2/black_list.add", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "en", "role": "partner", }, json={ "phone_format_id": 1, "phone_number": "705-712-51-20", }, ) data = response.json()

{ "status": "success", "data": { "description": "Successfully added", "row": { "chain_id": 7135, "date": "2024-05-02 08:31:16", "phone_format_id": 4, "phone_number": "7057125119", "client_account_id": 0, "client_branch_profile_id": 0, "blocked": true, "id": "82348" } } }

Add entry to blacklist

Authorization

Request body application/json

Responses

Request body `application/json`