Включить или скрыть поле формы

POST/api/crm/v2/base_settings.toggle_publish_statusv2

operationId: baseSettings.togglePublishStatus

Включает или скрывает поле формы. id задаёт поле в виде group_index, например sender_2. Если id неизвестен, возвращается ошибка 354.

Авторизация

api-token + language + role

Параметры запроса

branch_idintegerобязательный

Пример: 8920

Тело запроса `application/json`

object

idstringобязательный

Пример: sender_2

activebooleanобязательный

Пример: true

Ответы

object (Response)

statusstringобязательный

Значения:successerror

Пример: success

Один из вариантов

object

Сведения об ошибке

errorobjectобязательный

codeintegerобязательный

Код ошибки

variablesobject

descriptionstringобязательный

Описание ошибки

object

Массив данных (структура зависит от действия, см. примеры)

dataobjectобязательный

curl -X POST 'https://foodsoul.ru/api/crm/v2/base_settings.toggle_publish_status?branch_id=8920' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: ru' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":"sender_2","active":true}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/base_settings.toggle_publish_status?branch_id=8920', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'ru',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 'sender_2',
        'active' => true,
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/base_settings.toggle_publish_status?branch_id=8920", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "ru",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "id": "sender_2",
        "active": true
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/base_settings.toggle_publish_status?branch_id=8920",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "ru",
        "role": "partner",
    },
    json={
        "id": "sender_2",
        "active": True,
    },
)
data = response.json()

Ответ 200

{
  "error": {
    "code": 0,
    "variables": {},
    "description": "string"
  }
}

Запросы уходят на foodsoul.ru — хост этого портала, другой выбрать нельзя.

Включить или скрыть поле формы

Авторизация

Параметры запроса

Тело запроса application/json

Ответы

Тело запроса `application/json`