La référence de l'API est publiée en anglais.

Close an attention card: withdraw, archive or snooze

POST/api/companies/{companyId}/attention/{sourceKind}/{sourceId}/close
Personal API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Close an attention card: withdraw, archive or snooze.

Requires a member with organization write access. mode=withdraw closes the request for everyone because it is out of date; it is never an approval. It runs the source's own withdraw (interactions, including on a closed task) or cancel (decisions, approvals except hire requests), which writes its own activity entry and tells the agent. mode=archive and mode=snooze hide the card for the caller only, until its content changes or until until; the source stays open. Cards without a request to withdraw (budget, review, blocker, recovery, failed run, agent error, join request) return 422 for withdraw with the control to use instead. 404 when the caller cannot see the card; 409 with code attention_already_closed and the resolver when someone else answered first. Writes one attention.closed activity entry.

Autorisation

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.
sourceKindstringObligatoireThe sourcekind's id.
sourceIdstring (uuid)ObligatoireThe sourcekind's id.

Corps de la requête

application/json · obligatoire

modestringObligatoireone of: "withdraw", "archive", "snooze"
reasonstring | nullFacultatifat most 4000 characters
untilstring (date-time) | nullFacultatif
fingerprintstring | nullFacultatif1–200 characters

Réponses

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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Inbox