Enable or disable a special offer

POST/api/crm/v2/special_offers_list.toggle_statusv2

operationId: specialOffersList.toggleStatus

Enables or disables a special offer. If the offer is enabled with a start date in the past, the start date is set to the current time.

Authorization

api-token + language + role

Query parameters

branch_idinteger

Branch where the request is executed. A partner with multiple branches must provide this parameter; otherwise, the request will fail. For a partner with a single branch, the server will assign it automatically.

Example: 8778

Request body `application/json`

object

idintegerrequired

Example: 1

activebooleanrequired

Example: true

Responses

object (Response)

statusstringrequired

Values:successerror

Example: success

One of the options

object

Error details

errorobjectrequired

codeintegerrequired

Error code

variablesobject

descriptionstringrequired

Error description

object

Data array (structure depends on the action, see examples)

dataobjectrequired

curl -X POST 'https://foodsoul.ru/api/crm/v2/special_offers_list.toggle_status' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":1,"active":true}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/special_offers_list.toggle_status', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 1,
        'active' => true,
    ],
]);

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

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

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/special_offers_list.toggle_status",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "id": 1,
        "active": True,
    },
)
data = response.json()

Response 200

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

Requests are sent to foodsoul.ru — the host of this portal; you cannot choose another one.

Enable or disable a special offer

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`