Users

Update relationship nickname

Updates the nickname associated with a relationship (friend or blocked user). Nicknames are personal labels that override the user's display name in the current user's view. Returns updated relationship object.

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

Path parameters

user_idstring snowflake required

The ID of the user

Request body

nicknamestring nullable required

Custom nickname for this friend (max 256 characters)

Response

Success

idstring required

The unique identifier for the relationship

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

Changes

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