Tornar um campo de formulário obrigatório ou opcional

POST/api/crm/v2/base_settings.toggle_required_statusv2

operationId: baseSettings.toggleRequiredStatus

Alterna a obrigatoriedade de um campo do formulário. id define o campo no formato group_index, por exemplo, address_0. Se id for desconhecido, o erro 354 será retornado.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 8920

Corpo da solicitação `application/json`

object

idstringobrigatório

Exemplo: address_0

activebooleanobrigatório

Exemplo: true

Respostas

object (Response)

statusstringobrigatório

Valores:successerror

Exemplo: success

Uma das opções

object

Informações sobre o erro

errorobjectobrigatório

codeintegerobrigatório

Código de erro

variablesobject

descriptionstringobrigatório

Descrição do erro

object

Matriz de dados (a estrutura depende da ação, veja exemplos)

dataobjectobrigatório

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

Resposta 200

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

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Tornar um campo de formulário obrigatório ou opcional

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`