Retrieves a list of all relationships a given user is involved in. Relationships of all types are returned in a single array. It's up to the caller to use the of the relationship object to determine the appropriate way to handle that relationship. For relationship types that allow it, additional presence and profile data will be provided for each member of the relationship (unless excluded using the and parameters).

By default, we limit the number of relationships that can be returned in a single request. You can make subsequent requests to this API using the parameter to paginate through the remaining relationships.

Creates a relationship with one or more members. A relationship has a and a list of who are the users involved in the relationship. The requirements for creating a relationship are different depending on the of the relationship.

Each member of the relationship can also be given an optional which may indicate some semantic of the the relationship. A member can be identified by their user id or profile name.

For most relationships, if the caller is a user and is not included in the list, that user's membership is inferred to exist using the appropriate role. For example, if you create a relationship with one member, the caller is inferred to be the source of the relationship.

A relationship indicates that a user would like to create a friendship with another user. If no relationship (i.e. friendship) exists between the two users then the receiving game client will be notified that a relationship has been created, and the game can choose to notify the user and provide a mechanism for them to accept the friend request. A friend request is accepted by creating a reciprocal relationship targeting the originating user.

A relationship can ONLY have two members. The members have a role of either or to indicate the sender and the receiver of the request. If not provided the caller of the API will be inferred to be the and the other member will be the . A user cannot create a relationship with themselves as the .

A relationship cannot be directly created by a user, but is implicitly created when both users have created relationships with each other (i.e. sent and accepted a friend request).

A relationship is not directed, so the of the relationships do not have an assigned .

A relationship is a one-way relationship that enables a user to indicate that another user should be prevented from interacting with themselves for certain features and functionality (e.g. hiding presence, preventing the user from sending messages to them, etc.).

Presence blocking will be handled by the service to ensure that blocked users are unable to view the presence details of the blocker. For other functionality it is up to the developer to consume the relationships data and provide additional functionality. For example, a game client could filter out lobbies created by users that have been blocked, or a game server could prevent a blocked user from joining a game instance.

Deletes a relationship with the given .

Allows a user to send a message with a custom payload to another user. The Friends Service will only allow a user to send a message to a user that they have an active FRIEND relationship with.

The content of the payload can be customized entirely by the client. It is up to the client to determine how to best handle the message payload. For example, if the message payload contains a lobby ID, the client could show an Accept Invite toast. If the message contains a trade request, the client could enter a trading interface.

Retrieves both a subscription token and a channel name that the user should use to subscribe to notifications. The Friends Service updates the notifications channel as changes to the user's relationships occur. This includes updates to the presence state of any friends, new friend requests (i.e. relationships created), etc.

In general, the client should not depend on repeatedly polling the entire list of relationships to monitor for changes, but should instead fetch the entire list once and then register for notifications of any updates. This allows the client to keep the list up to date while minimizing overhead.

Updates the presence data for a user. This can be either or both of the availability and the activity.

Updates to the presence for a user will be pushed to all users with active FRIEND relationships with that user.

Retrieves the presence data for a specific user. If the caller is a user, then the target user must be one that the caller has an active relationship with.