Rendre un champ de formulaire obligatoire ou facultatif

POST/api/crm/v2/base_settings.toggle_required_statusv2

operationId: baseSettings.toggleRequiredStatus

Bascule le statut obligatoire d’un champ de formulaire. id spécifie le champ sous la forme group_index, par exemple address_0. Si id est inconnu, l’erreur 354 est renvoyée.

Autorisation

api-token + language + role

Paramètres de requête

branch_idintegerobligatoire

Exemple: 8920

Corps de la requête `application/json`

object

idstringobligatoire

Exemple: address_0

activebooleanobligatoire

Exemple: true

Réponses

object (Response)

statusstringobligatoire

Valeurs:successerror

Exemple: success

L'une des options

object

Informations sur l’erreur

errorobjectobligatoire

codeintegerobligatoire

Code d’erreur

variablesobject

descriptionstringobligatoire

Description de l’erreur

object

Tableau de données (la structure dépend de l'action, voir les exemples)

dataobjectobligatoire

curl -X POST 'https://foodsoul.ru/api/crm/v2/base_settings.toggle_required_status?branch_id=8920' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: fr' \
  -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.ru/api/crm/v2/base_settings.toggle_required_status?branch_id=8920', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'fr',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 'address_0',
        'active' => true,
    ],
]);

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/base_settings.toggle_required_status?branch_id=8920", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "fr",
        "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.ru/api/crm/v2/base_settings.toggle_required_status?branch_id=8920",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "fr",
        "role": "partner",
    },
    json={
        "id": "address_0",
        "active": True,
    },
)
data = response.json()

Réponse 200

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

Les requêtes sont envoyées à foodsoul.ru — l’hôte de ce portail, il n’est pas possible d’en choisir un autre.

Rendre un champ de formulaire obligatoire ou facultatif

Autorisation

Paramètres de requête

Corps de la requête application/json

Réponses

Corps de la requête `application/json`