Store pending invitations to a user's 3pid.

POST {{baseUrl}}/store-invite

Store pending invitations to a user's 3pid.

In addition to the request parameters specified below, an arbitrary number of other parameters may also be specified. These may be used in the invite message generation described below.

The service will generate a random token and an ephemeral key used for accepting the invite.

The service also generates a display_name for the inviter, which is a redacted version of address which does not leak the full contents of the address.

The service records persistently all of the above information.

It also generates an email containing all of this data, sent to the address parameter, notifying them of the invitation. The email should reference the inviter_name, room_name, room_avatar, and room_type (if present) from the request here.

Also, the generated ephemeral public key will be listed as valid on requests to /_matrix/identity/v2/pubkey/ephemeral/isvalid.

Currently, invites may only be issued for 3pids of the email medium.

Optional fields in the request should be populated to the best of the server's ability. Identity servers may use these variables when notifying the address of the pending invite for display purposes.

Request Body

{"medium"=>"email", "address"=>"foo@example.com", "room_id"=>"!something:example.org", "sender"=>"@bob:example.com", "room_alias"=>"#somewhere:example.org", "room_avatar_url"=>"mxc://example.org/s0meM3dia", "room_join_rules"=>"public", "room_name"=>"Bob's Emporium of Messages", "sender_display_name"=>"Bob Smith", "sender_avatar_url"=>"mxc://example.org/an0th3rM3dia", "room_type"=>"m.space"}

HEADERS

RESPONSES

status: OK

{"token":"nulla elit","public_keys":["sit amet deserunt Duis eiusm","tempor est et aliqua ad"],"display_name":"qui ipsum in"}