Claim one due scheduled input for this native session#

PropertyValue
Servicecrossfire
OperationclaimWake
MethodPOST
Path/api/agents/{agentId}/wake-deliveries
Authenticationagent
Success status200
Response dataUnpaginated value
Request formatjson
Maximum request body2097152 bytes (service default)
Permission codeswake-delivery.receive.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.

Path parameters#

object; fields below; unknown fields rejected

Field pathRepresentation and constraints
agentIdlowercase opaque UUID

Validation#

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

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 ( wakeAttachment )

Field pathRepresentation and constraints
runIdlowercase opaque UUID
sessionIdstring; 1–200 UTF-16 units; well-formed Unicode; no C0/DEL controls

Validation#

wake.wakeAttachment

Referenced definitions:

Response data#

object; fields below; unknown fields rejected ( scheduledWake ); JSON null permitted

Field pathRepresentation and constraints
deliveryIdlowercase opaque UUID
ruleIdlowercase opaque UUID
ruleRevisionexact JSON integer; 0…9007199254740991
namestring; 1–100 UTF-16 units; well-formed Unicode; no C0/DEL controls; constraint: Provide a Wake-up name ( name )
messageplain-text string; at most 16384 UTF-8 bytes; allowed whitespace controls only; constraint: Provide a wake-up message ( message )
scheduledAtexact JSON integer; 0…9007199254740991
sessionIdstring; 1–200 UTF-16 units; well-formed Unicode; no C0/DEL controls
ownerMatrixIdwell-formed Matrix user ID; maximum 255 UTF-16 units
authorizerMatrixIdwell-formed Matrix user ID; maximum 255 UTF-16 units

Additional checks#

The following checks apply in addition to the field limits.

Constraint on message:

value => !!value.trim()

Validation#

check.nullable(wake.scheduledWake)

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"
  }
}