MAmatrix
Account management

Adds contact information to the user's account.

This API endpoint uses the User-Interactive Authentication API.

Adds contact information to the user's account. Homeservers should use 3PIDs added through this endpoint for password resets instead of relying on the identity server.

Homeservers should prevent the caller from adding a 3PID to their account if it has already been added to another user's account on the homeserver.

This endpoint uses capabilities negotiation. Clients SHOULD check the value of the m.3pid_changes capability to determine if this endpoint is available.

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

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

Request

Request body

client_secretstring required

The client secret used in the session with the homeserver.

sidstring required

The session identifier given by the homeserver.

Example request

{
  "auth": {
    "example_credential": "verypoorsharedsecret",
    "session": "xxxxx",
    "type": "example.type.foo"
  },
  "client_secret": "d0nt-T3ll",
  "sid": "abc123987"
}

Response

The addition was successful.

object required

Changes

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