Set form field length

POST/api/crm/v2/base_settings.set_lengthv2

operationId: baseSettings.setLength

Sets the maximum length of a form field. id specifies the field as group_index. Applies only to fields with customizable length — see extendable. For other fields, error 355 is returned: their length is fixed. If id is unknown, error 354 is returned; if length is not a number — error 121. Valid range is from 1 to 1000.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

Request body `application/json`

object

idstringrequired

Example: additional_4

lengthintegerrequired

Example: 600

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/base_settings.set_length?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -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.ru/api/crm/v2/base_settings.set_length?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 'additional_4',
        'length' => 600,
    ],
]);

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/base_settings.set_length?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "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.ru/api/crm/v2/base_settings.set_length?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "id": "additional_4",
        "length": 600,
    },
)
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.

Set form field length

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`