API referansı İngilizce yayımlanır.

Update, archive, or restore a status card

PATCH/api/status-cards/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

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.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

idstringZorunluThe status card's id.

İstek gövdesi

application/json · zorunlu

interestPromptstringİsteğe bağlı1–20000 characters
titlestring | nullİsteğe bağlı1–300 characters
titlePinnedbooleanİsteğe bağlı
agentIdstring (uuid) | nullİsteğe bağlı
refreshPolicyobjectİsteğe bağlı
refreshPolicy.modestringİsteğe bağlıone of: "manual", "interval", "reactive"
refreshPolicy.intervalMinutesintegerİsteğe bağlı> 0
refreshPolicy.debounceSecondsintegerİsteğe bağlı> 0
refreshPolicy.maxUpdatesPerHourintegerİsteğe bağlı> 0
refreshPolicy.triggersanyZorunlu
refreshPolicy.activeHoursobjectİsteğe bağlı
refreshPolicy.activeHours.startstringZorunlupattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.endstringZorunlupattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.timezonestringZorunluat least 1 character
refreshPolicy.dailyTokenCapintegerİsteğe bağlı> 0
archivedbooleanİsteğe bağlı

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Status cards