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
OR
integer required

The ID of the user

Request body

staff_force_acceptboolean

Staff-only: immediately create the friendship

Response

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

Changes

Changed in 4 of the 21 revisions of this API.33228

  • dd0ad4ea1c8834See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ○

      response property nickname list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property user/avatar list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property user/global_name list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      the response's property pattern was changed from ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status

      response-property-pattern-changed

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 21 revisions, 2 have no diff computed.