Définir la longueur du champ de formulaire

POST/api/crm/v2/base_settings.set_lengthv2

operationId: baseSettings.setLength

Définit la longueur maximale d’un champ de formulaire. id spécifie le champ sous la forme group_index. Fonctionne uniquement pour les champs à longueur personnalisable — voir extendable. Pour les autres champs, une erreur 355 est retournée : leur longueur est fixe. Si id est inconnu, une erreur 354 est retournée ; si length n’est pas un nombre — erreur 121. La plage autorisée est de 1 à 1000.

Autorisation

api-token + language + role

Paramètres de requête

branch_idintegerobligatoire

Exemple: 1

Corps de la requête `application/json`

object

idstringobligatoire

Exemple: additional_4

lengthintegerobligatoire

Exemple: 600

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.pro/api/crm/v2/base_settings.set_length?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: fr' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":"additional_4","length":600}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/base_settings.set_length?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'fr',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 'additional_4',
        'length' => 600,
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/base_settings.set_length?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "fr",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "id": "additional_4",
        "length": 600
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/base_settings.set_length?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "fr",
        "role": "partner",
    },
    json={
        "id": "additional_4",
        "length": 600,
    },
)
data = response.json()

Réponse 200

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

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

Définir la longueur du champ de formulaire

Autorisation

Paramètres de requête

Corps de la requête application/json

Réponses

Corps de la requête `application/json`