III.3.a. Posts

Contents

Requests

Create post

/action/createPost

Creates a new post in the specified thread on the specified board. Returns an object containing the created post number and board name.

The required fields are:

• boardName The board to create the post on.
• threadNumber The thread to create the post in.
• Captcha challenge and response fields. Depends on the captcha engine used. Not required if the captcha uota for the user is greater than 0.

The optional fields are:

• text The message. Must not be empty if no files are attached.
• password The password that may be used to delete the post later. Stored as a SHA-1 hash in the database.
• markupMode List of markup rule groups used to render the text. May contain the following strings (typically separated by a comma ","):

• "EXTENDED_WAKABA_MARK"
• "BB_CODE"

• email Either an e-mail or the special value "sage" (case-insensitive) to indicate that a post must not bump (lift up) the thread.
• name User's name (nothing to do with the login, just any string).
• tripcode If the value of this field is "true" and the user is logged in, a tripcode is attached to the post.
• signAsOp If the user who made this post and the user who made the first post of the thread (the OP) are the same user, the special [OP] sign is attached to the post.
• subject The subject of the post.

You may also attach files to the post (at least one file is required if the text field is empty). File field names should follow the template: file_ID, where ID is an identifier unique for each file.

Files may also be specified as URLs, in which case the field name must follow the template: file_url_ID, where ID is an identifier unique for each file URL, and the value of the field should be either a URL (for example, http://site.com/files/image.jpg), or a special URL-like string, like: vk://UID_TID/TITLE, where UID is a Vkontakte user ID, TID is a Vkontakte audio track ID, and TITLE is a track title. In that case, the file or a Vkontakte audio-track will be downloaded by the server.

One more option to attach file(s) is to pass a list of file hashes, separated by commas as a value of the fileHashes field. In that case, the files will be copied if they exist in the database.

To set file rating, the file_ID_rating field may be used, where ID matches the ideintifier of file_ID or file_url_ID fields, or the hash of the corresponding file passed in the fileHashes field. The following file ratings are supported:

• SFW Safe for work (no socially condemned content). The default.
• R-15 Restricted for 15 years (contains ecchi, idols, violence).
• R-18 Restricted for 18 years (genitalis, coitus, offensive religious/racist/nationalist content).
• R-18G Restricted for 18 years, guidance advised (shemale, death, guro, scat, defecation, urination, etc.).

Example:

/action/createPost { boardName=b&threadNumber=9000&file_url_1=http://site.com/files/image.png }

{
    "boardName": "b",
    "postNumber": 12345
}

On any error, an error object is returned.

Example:

/action/createPost { boardName=b&threadNumber=9000 }

{
    "title": "Error",
    "errorMessage": "Error",
    "errorDescription": "Both file and comment are missing"
}

Edit post

For moderators and administrators only.

/action/editPost

See Create post for details.

Additional fields compared to Create post

postNumber

The number of a post to edit.

Removed fields compared to Create post

• file_<id>
• file_url_<id>
• file_<id>_rating
• fileHashes
• file
• captchaEngine
• signAsOp
• tripcode

password

This field is used to edit a post if hashpass is not specified (either for the request or for the post).

Note: users with access level MODER and higher may edit posts of the users with access level lower then their own.

Result

Returns an object with short post description (boardName and postNumber fields).

Error

On any error returns an error object. See Error object for details.

Delete post

Request

/action/deletePost

Fields

boardName

Name of the board of the target post.

postNumber

Numbr of the target post.

password

This field is used to delete a post if hashpass is not specified (either for the request or for the post).

Effect

Deletes the specified post. If a post is the first post in a thread, deletes entire thread.

Result

Returns an object with short thread description (boardName and threadNumber fields).

Error

On any error returns an error object. See Error object for details.