Справочник API публикуется на английском языке.

Update, archive, or restore a status card

PATCH/api/status-cards/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Update, archive, or restore a status card.

Archiving (archived: true) hides the card from the active list but keeps the card, its summary and its update history; it is not deleted. A person views and restores archived cards on the organization's Status page (Show archived, then Restore); give them the returned href as a Markdown link. Restoring (archived: false) starts a fresh full summary for a card with a compiled query, so restored content is regenerated before it is current.

Авторизация

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.

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

idstringОбязательныйThe status card's id.

Тело запроса

application/json · обязательно

interestPromptstringНеобязательный1–20000 characters
titlestring | nullНеобязательный1–300 characters
titlePinnedbooleanНеобязательный
agentIdstring (uuid) | nullНеобязательный
refreshPolicyobjectНеобязательный
refreshPolicy.modestringНеобязательныйone of: "manual", "interval", "reactive"
refreshPolicy.intervalMinutesintegerНеобязательный> 0
refreshPolicy.debounceSecondsintegerНеобязательный> 0
refreshPolicy.maxUpdatesPerHourintegerНеобязательный> 0
refreshPolicy.triggersanyОбязательный
refreshPolicy.activeHoursobjectНеобязательный
refreshPolicy.activeHours.startstringОбязательныйpattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.endstringОбязательныйpattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.timezonestringОбязательныйat least 1 character
refreshPolicy.dailyTokenCapintegerНеобязательный> 0
archivedbooleanНеобязательный

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Status cards