---
title: "Follows the target users"
method: POST
path: "/v1/user/follow"
tags: ["User"]
---

# Follows the target users

`POST /v1/user/follow`

## Request

- Base URL: `https://api.momentum-mod.org` (the document declares no server; this is the origin it was published from)
- URL: `https://api.momentum-mod.org/v1/user/follow`
- Auth: HTTP bearer

## Request body

- CreateFollowsDto
  - `targetUserIDs` unknown[], required: Array of userIDs to follow
    - unknown

## Response `200`

The follow DTOs of the local user following the target users

- FollowDto[]
  - `notifyOn` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7, required: The flags for the activities that the followee will be notified of when they are performed by the user they follow
  - `followedID` number, required: ID of the user being followed
  - `followeeID` number, required: ID of the user doing the following
  - `followed` UserDto
    - `id` number, required: The unique numeric ID of the user
    - `steamID` string, required: The Steam community ID (i.e. the uint64 format, not STEAM:...) of the user
    - `alias` string, required: The user's alias, which is either a current or previous Steam name, or something they set themselves
    - `country` string: Two-letter (ISO 3166-1 Alpha-2) country code for the user
    - `avatarURL` string, required
    - `profile` ProfileDto
      - `userID` number, required: The ID of the user
      - `bio` string, required: The text-based bio of the user
      - `socials` SocialsDto
        - `Discord` string, required: Discord Username
        - `Github` string, required: Github Username
        - `Instagram` string, required: Instagram Username
        - `Ko-fi` string, required: Ko-fi Username
        - `LinkedIn` string, required: LinkedIn Username
        - `Mastodon` string, required: Mastodon Username
        - `Patreon` string, required: Patreon Username
        - `Paypal` string, required: Paypal Username
        - `Spotify` string, required: Spotify Username
        - `Twitch` string, required: Twitch Username
        - `Twitter` string, required: Twitter Username
        - `YouTube` string, required: YouTube Username
    - `userStats` UserStatsDto
      - `cosXP` number, required: The user's total cosmetic XP
      - `level` number, required: The user's level
      - `mapsCompleted` number, required: Total maps completed
      - `runsSubmitted` number, required: Total runs submitted
      - `totalJumps` number, required: The user's total number of jumps
      - `totalStrafes` number, required: The user's total number of strafes
    - `roles` number, required: Flags of user's roles
    - `bans` number, required: Flags of user's bans
    - `createdAt` string, required: When the item was first created, as ISO8601 date string
  - `followee` UserDto
    - `id` number, required: The unique numeric ID of the user
    - `steamID` string, required: The Steam community ID (i.e. the uint64 format, not STEAM:...) of the user
    - `alias` string, required: The user's alias, which is either a current or previous Steam name, or something they set themselves
    - `country` string: Two-letter (ISO 3166-1 Alpha-2) country code for the user
    - `avatarURL` string, required
    - `profile` ProfileDto
      - `userID` number, required: The ID of the user
      - `bio` string, required: The text-based bio of the user
      - `socials` SocialsDto
        - `Discord` string, required: Discord Username
        - `Github` string, required: Github Username
        - `Instagram` string, required: Instagram Username
        - `Ko-fi` string, required: Ko-fi Username
        - `LinkedIn` string, required: LinkedIn Username
        - `Mastodon` string, required: Mastodon Username
        - `Patreon` string, required: Patreon Username
        - `Paypal` string, required: Paypal Username
        - `Spotify` string, required: Spotify Username
        - `Twitch` string, required: Twitch Username
        - `Twitter` string, required: Twitter Username
        - `YouTube` string, required: YouTube Username
    - `userStats` UserStatsDto
      - `cosXP` number, required: The user's total cosmetic XP
      - `level` number, required: The user's level
      - `mapsCompleted` number, required: Total maps completed
      - `runsSubmitted` number, required: Total runs submitted
      - `totalJumps` number, required: The user's total number of jumps
      - `totalStrafes` number, required: The user's total number of strafes
    - `roles` number, required: Flags of user's roles
    - `bans` number, required: Flags of user's bans
    - `createdAt` string, required: When the item was first created, as ISO8601 date string
  - `createdAt` string, required: When the item was first created, as ISO8601 date string

## Other responses

- `404`: Target user does not exist

---

[API](https://skmtc.dev/momentum-mod/apis/momentum-mod-api.md) - [All operations](https://skmtc.dev/momentum-mod/apis/momentum-mod-api/llms.txt) - [OpenAPI document](https://skmtc.dev/momentum-mod/apis/momentum-mod-api/revisions/0a88cfbbcc65?raw)
