Account management

Binds a 3PID to the user's account through an Identity Service.

Binds a 3PID to the user's account through the specified identity server.

Homeservers should not prevent this request from succeeding if another user has bound the 3PID. Homeservers should simply proxy any errors received by the identity server to the caller.

Homeservers should track successful binds so they can be unbound later.

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

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/account/3pid/bind/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

client_secretstring required

The client secret used in the session with the identity server.

id_access_tokenstring required

An access token previously registered with the identity server.

id_serverstring required

The identity server to use.

sidstring required

The session identifier given by the identity server.

Example request

{
  "client_secret": "d0nt-T3ll",
  "id_access_token": "abc123_OpaqueString",
  "id_server": "example.org",
  "sid": "abc123987"
}

Response

The addition was successful.

object required

Changes

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