Users

Send friend request

Sends a friend request to a user identified by user ID. Returns the new relationship object. Can fail if user not found or request already sent.

post/users/@me/relationships/{user_id}

Path parameters

string snowflake required

integer required

The ID of the user

staff_force_acceptboolean

Staff-only: immediately create the friendship

Success

idstring snowflake required

type1 | 2 | 3 | 4 required

Relationship type

sincestring date-time

ISO8601 timestamp of when the relationship was established

nicknamestring nullable required

A custom nickname set for the related user

share_voice_activityboolean required

Whether the current user has chosen to share their voice activity with this friend on the Active Now panel

friend_shares_voice_activityboolean required

Whether this friend has chosen to share their voice activity with the current user; for non-friend types this is always true