Acknowledge an SLA breach
Marks an SLA breach as acknowledged and records the user or API key that performed the action.
/api/sla/breaches/{id}/acknowledgeMarks an SLA breach as acknowledged and records the user or API key that performed the action. The breach remains unresolved.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
sla:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Convergent write: Retrying leaves the resource in the same resulting state. If the first request succeeded, a later retry may return conflict or not found because the change has already taken effect.
Path Parameters
Resource identifier.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidHeader Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "id": "447a768c-c7d9-4647-932b-a08cdf556e7b", "conversationId": "22222222-2222-4222-8222-222222222222", "orgId": "11111111-1111-4111-8111-111111111111", "projectId": "11111111-1111-4111-8111-111111111111", "policyId": "77777777-7777-4777-8777-777777777777", "policyName": "Priority support", "breachedMetric": "firstResponseTime", "operatorId": "44444444-4444-4444-8444-444444444444", "operatorName": "Alice Johnson", "breachedAt": "2026-06-23T10:00:00.000Z", "durationSeconds": 320, "resolvedAt": null, "status": "acknowledged", "acknowledgedBy": "55555555-5555-4555-8555-555555555555", "acknowledgedAt": "2026-06-23T10:05:00.000Z", "resolvedBy": null}Request examples
curl
curl --request POST \
'https://api.convor.io/api/sla/breaches/447a768c-c7d9-4647-932b-a08cdf556e7b/acknowledge' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/sla/breaches/447a768c-c7d9-4647-932b-a08cdf556e7b/acknowledge", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_..."
},
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?