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
• 403
• 404
• 422
• 500

---

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": {}
}

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
code string
message string

{
  "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
code string
message string

{
  "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
code string
message string

{
  "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
code string
message string

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

Loading...