User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

• Use prelive.quran.com for auth-related testing.
• Use prelive.quranreflect.org for Quran Reflect paths where applicable.
• Do not mix production sessions or production user data with pre-live testing.

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...