Client Config

Clients can store custom config data for their account on their homeserver. This account data will be synced between different devices and can persist across installations on a particular device. Users may only view the account data for their own account.

The account data may be either global or scoped to a particular room. There is no inheritance mechanism here: a given type of data missing from a room’s account data does not fall back to the global account data with the same type.

Events

The client receives the account data as events in the account_data sections of a /sync response.

These events can also be received in a /events response or in the account_data section of a room in a /sync response. m.tag events appearing in /events will have a room_id with the room the tags are for.

Client Behaviour

{
  "custom_account_data_key": "custom_config_value"
}

{
  "errcode": "M_FORBIDDEN",
  "error": "Cannot add account data for other users."
}

{
  "errcode": "M_NOT_FOUND",
  "error": "Account data not found."
}

{
  "custom_account_data_key": "custom_config_value"
}

{}

{
  "errcode": "M_NOT_JSON",
  "error": "Content must be a JSON object."
}

{
  "errcode": "M_FORBIDDEN",
  "error": "Cannot add account data for other users."
}

{
  "errcode": "M_BAD_JSON",
  "error": "Cannot set m.fully_read through this API."
}

{
  "custom_account_data_key": "custom_config_value"
}

{
  "errcode": "M_FORBIDDEN",
  "error": "Cannot add account data for other users."
}

{
  "errcode": "M_NOT_FOUND",
  "error": "Room account data not found."
}

{
  "custom_account_data_key": "custom_account_data_value"
}

{}

{
  "errcode": "M_NOT_JSON",
  "error": "Content must be a JSON object."
}

{
  "errcode": "M_FORBIDDEN",
  "error": "Cannot add account data for other users."
}

{
  "errcode": "M_BAD_JSON",
  "error": "Cannot set m.fully_read through this API."
}

Server Behaviour

Servers MUST reject clients from setting account data for event types that the server manages. Currently, this only includes m.fully_read.