Skip to content
UltimateTeam.ai Docs

Acknowledge a compliance alert

POST
/api/v1/compliance/alerts/{alert_id}/acknowledge
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/compliance/alerts/example/acknowledge \
  --header 'X-API-Key: <X-API-Key>'

Mark a compliance alert as acknowledged.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
alert_id
required
Alert Id
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
AcknowledgeAlertEnvelope

Typed envelope for POST /alerts/{alert_id}/acknowledge.

object
data
required
AcknowledgeAlertResponse

Response body after acknowledging a compliance alert.

Attributes: alert_id: The acknowledged alert’s identifier. acknowledged: Whether the acknowledgement succeeded. detail: Additional details about the alert state.

object
acknowledged
required
Acknowledged

Whether acknowledgement succeeded

boolean
alert_id
required
Alert Id

The acknowledged alert ID

string
detail
Any of:
object
key
additional properties
any
meta
required
ResponseMeta

Standard metadata attached to every API response.

object
request_id
required
Request Id

Unique request identifier

string
timestamp
required
Timestamp

Server timestamp of the response

string format: date-time
Examplegenerated
{
  "data": {
    "acknowledged": true,
    "alert_id": "example",
    "detail": {}
  },
  "meta": {
    "request_id": "example",
    "timestamp": "2026-04-15T12:00:00Z"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}