Muuda vormiväli kohustuslikuks või vabatahtlikuks

POST/api/crm/v2/base_settings.toggle_required_statusv2

operationId: baseSettings.toggleRequiredStatus

Lülitab vormivälja kohustuslikkuse olekut. id määrab välja kujul group_index, näiteks address_0. Kui id pole teada, tagastatakse viga 354.

Autoriseerimine

api-token + language + role

Päringu parameetrid

branch_idintegerkohustuslik

Näide: 8920

Päringu keha `application/json`

object

idstringkohustuslik

Näide: address_0

activebooleankohustuslik

Näide: true

Vastused

object (Response)

statusstringkohustuslik

Väärtused:successerror

Näide: success

Üks variantidest

object

Teave vea kohta

errorobjectkohustuslik

codeintegerkohustuslik

Veakood

variablesobject

descriptionstringkohustuslik

Veakirjeldus

object

Andmete massiiv (struktuur sõltub toimingust, vt näiteid)

dataobjectkohustuslik

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

<?php

$client = new \GuzzleHttp\Client();

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

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

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

import requests

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

Vastus 200

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

Päringud saadetakse aadressile foodsoul.pro — see on selle portaali host, teist valida ei saa.

Muuda vormiväli kohustuslikuks või vabatahtlikuks

Autoriseerimine

Päringu parameetrid

Päringu keha application/json

Vastused

Päringu keha `application/json`