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

Resolve a budget incident

POST/api/companies/{companyId}/budget-incidents/{incidentId}/resolve
Personal API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Resolve a budget incident.

People only: agent credentials get 403, so an agent cannot raise a limit or resume a budget-stopped agent. A member chooses the new amount and resumes on the Budgets page: link Open budgets with this conversation's organization prefix as , and reply.

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.
incidentIdstringObligatoireThe incident's id.

Corps de la requête

application/json · obligatoire

actionstringObligatoireone of: "keep_paused", "raise_budget_and_resume"
amountintegerFacultatif≥ 0≤ 2147483647
decisionNotestring | nullFacultatif

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.

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

Costs and budgets