Update, archive, or restore a status card

PATCH/api/status-cards/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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.

Authorization

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. How keys work.

Path parameters

idstringRequiredThe status card's id.

Request body

application/json · required

interestPromptstringOptional1–20000 characters
titlestring | nullOptional1–300 characters
titlePinnedbooleanOptional
agentIdstring (uuid) | nullOptional
refreshPolicyobjectOptional
refreshPolicy.modestringOptionalone of: "manual", "interval", "reactive"
refreshPolicy.intervalMinutesintegerOptional> 0
refreshPolicy.debounceSecondsintegerOptional> 0
refreshPolicy.maxUpdatesPerHourintegerOptional> 0
refreshPolicy.triggersanyRequired
refreshPolicy.activeHoursobjectOptional
refreshPolicy.activeHours.startstringRequiredpattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.endstringRequiredpattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.timezonestringRequiredat least 1 character
refreshPolicy.dailyTokenCapintegerOptional> 0
archivedbooleanOptional

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Status cards