User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Toggle follow/unfollow a user

Follow or unfollow another user. When following, their posts will appear in your FOLLOWING feed. Can optionally specify action to force follow/unfollow.

Path Parameters

followeeId string required

UUID of the user to follow/unfollow

application/json

Request Body

Optional: specify "follow" or "unfollow" action explicitly

action string

Possible values: [follow, unfollow]

The intended action: follow or unfollow

Responses

• 200
• 400
• 401

---

Follow status changed - returns new state

application/json

Schema

Example (from schema)

Example

---

Schema

followed boolean

true if now following

{
  "followed": true
}

{
  "followed": true
}

Cannot follow yourself or action already in desired state

User not authenticated

Loading...