Publish note
Publish a note to QR.
Path Parameters
The unique identifier of the note to be retrieved or manipulated.
Request Body
Possible values: >= 6 characters and <= 10000 characters
The main content of the note, must be between the specified minimum and maximum length.
Possible values: Value must match regular expression ^(\d+):(\d+)-(\d+):(\d+)$
An array of verse ranges associated with the note.
- 200
- 403
- 404
- 422
- 500
Request has been handled successfully.
Schema
data object
Response object indicating the success of the note publishing operation and the optional post ID if successful.
{
"success": true,
"data": {
"success": true,
"postId": 123
}
}
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.
Schema
error object
{
"success": false,
"error": {
"code": "ForbiddenError",
"message": "Token expired"
}
}
Not Found. The resource being accessed does not exist.
Schema
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.
Schema
error object
{
"success": false,
"error": {
"code": "ValidationError",
"message": "`id` is required"
}
}
Server Error. Something went wrong, try again later.
Schema
error object
{
"success": false,
"error": {
"code": "ServerError",
"message": "Something went wrong"
}
}