Accept a verified native invitation with read-and-reply access#

PropertyValue
Servicecrossfire
OperationacceptRoomInvitation
MethodPOST
Path/api/agents/{agentId}/room-invitation-acceptances
Authenticationagent
Success status200
Response dataUnpaginated value
Request formatjson
Maximum request body2097152 bytes (service default)
Permission codesroom-invitation.accept.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

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

Validation#

check.object({ roomId: check.roomId })

Referenced definitions:

Response data#

object; fields below; unknown fields rejected

Field pathRepresentation and constraints
acceptedboolean

Validation#

check.object({ accepted: check.boolean })

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