MAmatrix
Account management

Removes a user's third-party identifier from an identity server.

Removes a user's third-party identifier from the provided identity server without removing it from the homeserver.

Unlike other endpoints, this endpoint does not take an id_access_token parameter because the homeserver is expected to sign the request to the identity server instead.

post/_matrix/client/v3/account/3pid/unbind

Request

Request body

addressstring required

The third-party address being removed.

id_serverstring

The identity server to unbind from. If not provided, the homeserver MUST use the id_server the identifier was added through. If the homeserver does not know the original id_server, it MUST return a id_server_unbind_result of no-support.

medium'email' | 'msisdn' required

The medium of the third-party identifier being removed.

Example request

{
  "address": "example@example.org",
  "id_server": "example.org",
  "medium": "email"
}

Response

The identity server has disassociated the third-party identifier from the user.

id_server_unbind_result'no-support' | 'success' required

An indicator as to whether or not the identity server was able to unbind the 3PID. success indicates that the identity server has unbound the identifier whereas no-support indicates that the identity server refuses to support the request or the homeserver was not able to determine an identity server to unbind from.

Example response

{
  "id_server_unbind_result": "success"
}

Changes

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