Включить или выключить подписку

PATCH/api/partner/v1/webhooks/{id}

Scope: cards:write

Приостанавливает или возобновляет доставки на подписку. Очередь GET /events получает события в любом случае.

Параметры пути

Параметр	Тип	Обяз.	Описание
`id`	string (uuid)	да	Идентификатор подписки

Тело запроса

Поле	Тип	Обяз.	Описание
`is_active`	boolean	да	`false` приостанавливает доставки, `true` возобновляет

Пример запроса

BODY='{"is_active":false}'
TS=$(date +%s)
SIG=$(printf '%s\n%s\n%s\n%s' "$TS" "PATCH" "/api/partner/v1/webhooks/5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e" "$BODY" \
  | openssl dgst -sha256 -hmac "$PP_SECRET" -hex | awk '{print $NF}')

curl -sS -X PATCH "https://api.plativputi.com/api/partner/v1/webhooks/5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e" \
  -H "X-Key-Id: $PP_KEY_ID" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG" \
  -H "Content-Type: application/json" \
  -d "$BODY"

const res = await pp("PATCH", "/webhooks/5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e", {
  "is_active": false
});

res = pp("PATCH", "/webhooks/5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e", body={
    "is_active": False,
})

$res = pp('PATCH', '/webhooks/5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e', [
    'is_active' => false,
]);

pp() — функция-обёртка с подписью из раздела Аутентификация и подпись.

Ответ

200 OK — OkOutputBody

Поле	Тип	Обяз.	Описание
`ok`	boolean	да	При успехе всегда `true`

Примеры ответа

{
  "ok": true
}

Ошибки

HTTP	Код	Когда
404	`not_found`	Подписки нет или она принадлежит другому аккаунту.

Плюс общие ошибки подписи и лимитов — см. Ошибки.