Update a post

Update a post.

Path Parameters

postId string required

The id of the comment to be updated.

application/json

Request Body

body string required

The body of the post.

roomId integer

The Id of the room the post will be posted in.

isPrivate boolean

Default value: false

Whether the post should be posted as a private note.

tagIds integer[]

The Ids of the tags the post is attached to

references object[]
The Surahs/Ayahs the post relates to. If references is not passed with update post API, existing references of the post will be removed.
Array [
surahId integer required
Possible values: >= 1 and <= 114
The Surah number
fromAyah integer nullable
Possible values: >= 1 and <= 286
The start of the range of Ayah(s) in a Surah that the post relates to.
If it's a single Ayah,fromAyah and toAyah should have the same value.
If the post belongs to the entire Surah, fromAyah and toAyah should be left empty
toAyah integer nullable
Possible values: >= 1 and <= 286
The end of the range of Ayah(s) in a Surah that the post relates to.
If it's a single Ayah,fromAyah and toAyah should have the same value.
If the post belongs to the entire Surah, fromAyah and toAyah should be left empty
isSurah boolean
Default value: false
Whether the post belongs to the entire Surah.
]

Responses

• 200
• 400
• 401
• 403
• 404
• 422
• 429
• 500
• 502
• 503
• 504

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object

message

Possible values: [Post was updated successfully]

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

The request is missing required parameters or is invalid.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request is missing required headers or is invalid",
  "type": "invalid_request",
  "success": false
}

The request is unauthorized.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request requires user authentication",
  "type": "unauthorized",
  "success": 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

message string
type string
success boolean

{
  "message": "The server understood the request, but refuses to authorize it",
  "type": "forbidden",
  "success": false
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The requested resource could not be found",
  "type": "not_found",
  "success": false
}

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

message string
type string
success boolean

{
  "message": "The request was well-formed but was unable to be followed due to semantic errors",
  "type": "unprocessable_entity",
  "success": false
}

Too many requests, please try again later.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "Too many requests, please try again later",
  "type": "rate_limit_exceeded",
  "success": false
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server encountered an internal error and was unable to complete your request",
  "type": "internal_server_error",
  "success": false
}

Invalid response from the upstream server

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
  "type": "bad_gateway",
  "success": false
}

The server is currently unable to handle the request due to a temporary overload or scheduled maintenance

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
  "type": "service_unavailable",
  "success": false
}

The server did not receive a timely response from the upstream server.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
  "type": "gateway_timeout",
  "success": false
}

PUT /v1/posts/:postId

Authorization

name: x-auth-tokentype: apiKeyin: headerdescription: The JWT access token required for accessing the endpoints.

name: x-client-idtype: apiKeyin: headerdescription: Your client id

Request

Base URL

https://apis-prelive.quran.foundation/auth

x-auth-token

x-client-id

postId — path required

Body

{
  "body": "I love Allah and his messenger.",
  "roomId": 123,
  "isPrivate": false,
  "tagIds": [
    432
  ],
  "references": [
    {
      "surahId": 2
    },
    {
      "surahId": 5,
      "fromAyah": 6,
      "toAyah": 8
    },
    {
      "surahId": 114,
      "fromAyah": 2,
      "toAyah": 2
    }
  ]
}

curl / cURL

curl -L -X PUT 'https://apis-prelive.quran.foundation/auth/v1/posts/:postId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>' \
--data-raw '{
  "body": "I love Allah and his messenger.",
  "roomId": 123,
  "isPrivate": false,
  "tagIds": [
    432
  ],
  "references": [
    {
      "surahId": 2
    },
    {
      "surahId": 5,
      "fromAyah": 6,
      "toAyah": 8
    },
    {
      "surahId": 114,
      "fromAyah": 2,
      "toAyah": 2
    }
  ]
}'

python / requests

curl -L -X PUT 'https://apis-prelive.quran.foundation/auth/v1/posts/:postId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>' \
--data-raw '{
  "body": "I love Allah and his messenger.",
  "roomId": 123,
  "isPrivate": false,
  "tagIds": [
    432
  ],
  "references": [
    {
      "surahId": 2
    },
    {
      "surahId": 5,
      "fromAyah": 6,
      "toAyah": 8
    },
    {
      "surahId": 114,
      "fromAyah": 2,
      "toAyah": 2
    }
  ]
}'

go / native

curl -L -X PUT 'https://apis-prelive.quran.foundation/auth/v1/posts/:postId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>' \
--data-raw '{
  "body": "I love Allah and his messenger.",
  "roomId": 123,
  "isPrivate": false,
  "tagIds": [
    432
  ],
  "references": [
    {
      "surahId": 2
    },
    {
      "surahId": 5,
      "fromAyah": 6,
      "toAyah": 8
    },
    {
      "surahId": 114,
      "fromAyah": 2,
      "toAyah": 2
    }
  ]
}'

nodejs / axios

curl -L -X PUT 'https://apis-prelive.quran.foundation/auth/v1/posts/:postId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>' \
--data-raw '{
  "body": "I love Allah and his messenger.",
  "roomId": 123,
  "isPrivate": false,
  "tagIds": [
    432
  ],
  "references": [
    {
      "surahId": 2
    },
    {
      "surahId": 5,
      "fromAyah": 6,
      "toAyah": 8
    },
    {
      "surahId": 114,
      "fromAyah": 2,
      "toAyah": 2
    }
  ]
}'

ruby / Net::HTTP

curl -L -X PUT 'https://apis-prelive.quran.foundation/auth/v1/posts/:postId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>' \
--data-raw '{
  "body": "I love Allah and his messenger.",
  "roomId": 123,
  "isPrivate": false,
  "tagIds": [
    432
  ],
  "references": [
    {
      "surahId": 2
    },
    {
      "surahId": 5,
      "fromAyah": 6,
      "toAyah": 8
    },
    {
      "surahId": 114,
      "fromAyah": 2,
      "toAyah": 2
    }
  ]
}'

csharp / RestSharp

curl -L -X PUT 'https://apis-prelive.quran.foundation/auth/v1/posts/:postId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>' \
--data-raw '{
  "body": "I love Allah and his messenger.",
  "roomId": 123,
  "isPrivate": false,
  "tagIds": [
    432
  ],
  "references": [
    {
      "surahId": 2
    },
    {
      "surahId": 5,
      "fromAyah": 6,
      "toAyah": 8
    },
    {
      "surahId": 114,
      "fromAyah": 2,
      "toAyah": 2
    }
  ]
}'

php / cURL

curl -L -X PUT 'https://apis-prelive.quran.foundation/auth/v1/posts/:postId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>' \
--data-raw '{
  "body": "I love Allah and his messenger.",
  "roomId": 123,
  "isPrivate": false,
  "tagIds": [
    432
  ],
  "references": [
    {
      "surahId": 2
    },
    {
      "surahId": 5,
      "fromAyah": 6,
      "toAyah": 8
    },
    {
      "surahId": 114,
      "fromAyah": 2,
      "toAyah": 2
    }
  ]
}'

java / OkHttp

curl -L -X PUT 'https://apis-prelive.quran.foundation/auth/v1/posts/:postId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>' \
--data-raw '{
  "body": "I love Allah and his messenger.",
  "roomId": 123,
  "isPrivate": false,
  "tagIds": [
    432
  ],
  "references": [
    {
      "surahId": 2
    },
    {
      "surahId": 5,
      "fromAyah": 6,
      "toAyah": 8
    },
    {
      "surahId": 114,
      "fromAyah": 2,
      "toAyah": 2
    }
  ]
}'

powershell / RestMethod

curl -L -X PUT 'https://apis-prelive.quran.foundation/auth/v1/posts/:postId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>' \
--data-raw '{
  "body": "I love Allah and his messenger.",
  "roomId": 123,
  "isPrivate": false,
  "tagIds": [
    432
  ],
  "references": [
    {
      "surahId": 2
    },
    {
      "surahId": 5,
      "fromAyah": 6,
      "toAyah": 8
    },
    {
      "surahId": 114,
      "fromAyah": 2,
      "toAyah": 2
    }
  ]
}'