Ativar ou desativar webhooks da filial

POST/api/crm/v2/webhooks_subscriptions.update_settingsv2

operationId: webhooksSubscriptions.updateSettings

Ativa ou desativa os webhooks da filial. Ao ativar pela primeira vez, um segredo de assinatura é criado, por isso as configurações da filial são retornadas na resposta.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 8412

Corpo da solicitação `application/json`

object

enabledbooleanobrigatório

Desativa imediatamente todas as assinaturas da filial

Exemplo: true

Respostas

OK

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

settingsobject (WebhooksBranchSettings)

secretstringpode ser nulo

null, até que a rede crie o segredo

Exemplo: 9f2c…

enabledbooleanobrigatório

Exemplo: true

curl -X POST 'https://foodsoul.ru/api/crm/v2/webhooks_subscriptions.update_settings?branch_id=8412' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/webhooks_subscriptions.update_settings?branch_id=8412', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
    'json' => [
        'enabled' => true,
    ],
]);

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/webhooks_subscriptions.update_settings?branch_id=8412", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "enabled": true
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/webhooks_subscriptions.update_settings?branch_id=8412",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
    json={
        "enabled": True,
    },
)
data = response.json()

Resposta 200

{
  "status": "success",
  "data": {
    "settings": {
      "secret": "9f2c…",
      "enabled": true
    }
  }
}

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