Hacer que un campo del formulario sea obligatorio o no obligatorio

POST/api/crm/v2/base_settings.toggle_required_statusv2

operationId: baseSettings.toggleRequiredStatus

Cambia el estado de obligatoriedad de un campo del formulario. id especifica el campo en formato group_index, por ejemplo, address_0. Si id es desconocido, se devuelve el error 354.

Autorización

api-token + language + role

Parámetros de consulta

branch_idintegerobligatorio

Ejemplo: 8920

Cuerpo de la solicitud `application/json`

object

idstringobligatorio

Ejemplo: address_0

activebooleanobligatorio

Ejemplo: true

Respuestas

object (Response)

statusstringobligatorio

Valores:successerror

Ejemplo: success

Una de las opciones

object

Información sobre el error

errorobjectobligatorio

codeintegerobligatorio

Código de error

variablesobject

descriptionstringobligatorio

Descripción del error

object

Matriz de datos (la estructura depende de la acción, ver ejemplos)

dataobjectobligatorio

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: es' \
  -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' => 'es',
        '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": "es",
        "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": "es",
        "role": "partner",
    },
    json={
        "id": "address_0",
        "active": True,
    },
)
data = response.json()

Respuesta 200

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

Las solicitudes se envían a foodsoul.pro, que es el host de este portal; no se puede elegir otro.

Hacer que un campo del formulario sea obligatorio o no obligatorio

Autorización

Parámetros de consulta

Cuerpo de la solicitud application/json

Respuestas

Cuerpo de la solicitud `application/json`