Publicar u ocultar un distrito

POST/api/crm/v2/districts.toggle_publish_statusv2

operationId: districts.togglePublishStatus

Publica u oculta un distrito. Es el mismo indicador que el icono de ojo en la lista de distritos y la opción "Ocultar" en el menú del distrito. Un distrito oculto desaparece del mapa y de la leyenda, pero permanece en la lista y en los menús desplegables.

Autorización

api-token + language + role

Parámetros de consulta

branch_idintegerobligatorio

Ejemplo: 1

Cuerpo de la solicitud `application/json`

object

idintegerobligatorio

Ejemplo: 1

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/districts.toggle_publish_status?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: es' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":1,"active":true}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/districts.toggle_publish_status?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'es',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 1,
        'active' => true,
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/districts.toggle_publish_status?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "es",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "id": 1,
        "active": true
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/districts.toggle_publish_status?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "es",
        "role": "partner",
    },
    json={
        "id": 1,
        "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.

Publicar u ocultar un distrito

Autorización

Parámetros de consulta

Cuerpo de la solicitud application/json

Respuestas

Cuerpo de la solicitud `application/json`