Bulk deletion of devices

This API endpoint uses the User-Interactive Authentication API, except when used by an application service.

Deletes the given devices, and invalidates any access token associated with them.

WARNING: When this endpoint requires User-Interactive Authentication, it cannot be used when the access token was obtained via the OAuth 2.0 API.

WARNING: [Added in v1.18] OAuth 2.0 aware clients MUST NOT use this endpoint when the server supports the OAuth 2.0 API. Instead they MUST refer the user to the account management URL, if available.

post/_matrix/client/v3/delete_devices

Request

Base URL
https://matrix.org
Auth
- API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/delete_devices/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

devicesstring[] required

The list of device IDs to delete.

Example request

{
  "auth": {
    "example_credential": "verypoorsharedsecret",
    "session": "xxxxx",
    "type": "example.type.foo"
  },
  "devices": [
    "QBUAZIFURK",
    "AUIECTSRND"
  ]
}

Response

The devices were successfully removed, or had been removed previously.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.