Idempotent blocked mention response#

PropertyValue
Servicecrossfire
OperationwakeNotice
MethodPUT
Path/api/agents/{agentId}/wake-notices/{eventId}
Authenticationagent
Success status202
Response dataUnpaginated value
Request formatjson
Maximum request body2097152 bytes (service default)
Permission codeswake-notice.publish.self

Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.

HTTP 202 means the request was accepted for processing. Check the operation’s status to find out whether it completed.

Path parameters#

object; fields below; unknown fields rejected

Field pathRepresentation and constraints
agentIdlowercase opaque UUID
eventIdopaque Matrix event ID; maximum 255 UTF-16 units

Validation#

check.object({ agentId: check.identifier, eventId: check.eventId })

Referenced definitions:

Query parameters#

custom validation: none ; see function below

Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.

Additional checks#

The following checks apply in addition to the field limits.

Constraint on value:

export function none(input: unknown) {
    const parsed = listQuery([])(input);
    return parsed.ok ? success({}) : parsed;
}

Validation#

query.none

Referenced definitions:

Request body#

object; fields below; unknown fields rejected ( wakeNotice )

Field pathRepresentation and constraints
roomIdimmutable Matrix room ID; maximum 255 UTF-16 units

Validation#

req.wakeNotice

Referenced definitions:

Response data#

object; fields below; unknown fields rejected ( notice )

Field pathRepresentation and constraints
outcomepending or sent or denied or not-applicable or not-permitted or rate-limited

Validation#

res.notice

Referenced definitions:

Response envelope#

A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.

{
  "data": "<value matching the response-data validator>",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000001"
  }
}