links
POST /v1/content/campaigns/{campaignId}/pause
Hold every article that has not started.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/content/campaigns/{campaignId}/pause \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Holds every queued article. Acts only on articles that have not started — one already being written has been paid for, and one already published is on a customer's site, so pausing cannot mean un-publishing and must not appear to. affected is how many were actually held, so a screen can say "paused 8 of 12" rather than reporting a silent success the customer's own queue contradicts. Gated on links.edit.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
campaignId (path) | string | Да | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
affected | integer | Да | How many articles the action actually touched. A campaign of twelve with four already written reports 8 for a pause, so a screen can say "paused 8 of 12" rather than a silent… |
campaign | ContentCampaign | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422