Publier ou masquer un district

POST/api/crm/v2/districts.toggle_publish_statusv2

operationId: districts.togglePublishStatus

Publie ou masque un district. Il s'agit du même indicateur que l'icône œil dans la liste des districts et que l'option « Masquer » dans le menu du district. Un district masqué disparaît de la carte et de la légende, mais reste visible dans la liste et dans les menus déroulants.

Autorisation

api-token + language + role

Paramètres de requête

branch_idintegerobligatoire

Exemple: 1

Corps de la requête `application/json`

object

idintegerobligatoire

Exemple: 1

activebooleanobligatoire

Exemple: true

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/districts.toggle_publish_status?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: fr' \
  -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' => 'fr',
        '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": "fr",
        "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": "fr",
        "role": "partner",
    },
    json={
        "id": 1,
        "active": True,
    },
)
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.

Publier ou masquer un district

Autorisation

Paramètres de requête

Corps de la requête application/json

Réponses

Corps de la requête `application/json`