La referencia de la API se publica en inglés.

Update, archive, or restore a status card

PATCH/api/status-cards/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

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.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

idstringObligatorioThe status card's id.

Cuerpo de la solicitud

application/json · obligatorio

interestPromptstringOpcional1–20000 characters
titlestring | nullOpcional1–300 characters
titlePinnedbooleanOpcional
agentIdstring (uuid) | nullOpcional
refreshPolicyobjectOpcional
refreshPolicy.modestringOpcionalone of: "manual", "interval", "reactive"
refreshPolicy.intervalMinutesintegerOpcional> 0
refreshPolicy.debounceSecondsintegerOpcional> 0
refreshPolicy.maxUpdatesPerHourintegerOpcional> 0
refreshPolicy.triggersanyObligatorio
refreshPolicy.activeHoursobjectOpcional
refreshPolicy.activeHours.startstringObligatoriopattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.endstringObligatoriopattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.timezonestringObligatorioat least 1 character
refreshPolicy.dailyTokenCapintegerOpcional> 0
archivedbooleanOpcional

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Status cards