Toggle following a user

Toggle following a user.

Path Parameters

username string required

The username of the user to be followed/un-followed.

Responses

Request has been handled successfully.

application/json

Schema

Example (from schema)

Schema

success boolean

data object

{
  "success": true,
  "data": {
    "followed": false
  }
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

Schema

success boolean

error object

{
  "success": false,
  "error": {
    "code": "ForbiddenError",
    "message": "Token expired"
  }
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

Schema

success boolean

error object

{
  "success": false,
  "error": {
    "code": "NotFoundError",
    "message": "The resource you're looking for does not exist"
  }
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

Schema

success boolean

error object

{
  "success": false,
  "error": {
    "code": "ValidationError",
    "message": "`id` is required"
  }
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

Schema

success boolean

error object

{
  "success": false,
  "error": {
    "code": "ServerError",
    "message": "Something went wrong"
  }
}

POST /v1/users/:username/toggleFollow

Authorization

name: o_t_htype: apiKeyin: header

Request

Base URL

https://auth.quran.com

ApiKeyAuth

username — path required

Body

{}

curl / cURL
curl -L -X POST 'https://auth.quran.com/v1/users/:username/toggleFollow' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{}'

python / requests
curl -L -X POST 'https://auth.quran.com/v1/users/:username/toggleFollow' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{}'

go / native
curl -L -X POST 'https://auth.quran.com/v1/users/:username/toggleFollow' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{}'

nodejs / axios
curl -L -X POST 'https://auth.quran.com/v1/users/:username/toggleFollow' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{}'

ruby / Net::HTTP
curl -L -X POST 'https://auth.quran.com/v1/users/:username/toggleFollow' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{}'

csharp / RestSharp
curl -L -X POST 'https://auth.quran.com/v1/users/:username/toggleFollow' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{}'

php / cURL
curl -L -X POST 'https://auth.quran.com/v1/users/:username/toggleFollow' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{}'

java / OkHttp
curl -L -X POST 'https://auth.quran.com/v1/users/:username/toggleFollow' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{}'

powershell / RestMethod
curl -L -X POST 'https://auth.quran.com/v1/users/:username/toggleFollow' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{}'