Skip to content
This repository was archived by the owner on Aug 6, 2022. It is now read-only.

III.3.b. Threads

Andrey Bogdanov edited this page Feb 24, 2016 · 9 revisions

Create thread

Request

/action/createThread

Fields

boardName

Name of the board to create thread on.

captchaEngine

Identifier of captcha engine used to solve/check captcha. Optional if user captcha quota is greater than 0 for the board.

<captcha>

Actual field(s) name(s) depends on the captcha engine used. See Captcha engines for details. Optional if user captcha quota is greater than 0 for the board.

fileHashes

List of comma-separated file hashes. Optional. If corresponding files exist on the server, they will be copied and used just as normal attached files.

email

Poster e-mail. Optional.

name

Poster name. Optional.

subject

Thread subject. Optional.

text

Post text. Optional if one or more files are attached (including file hashes and file URLs).

signAsOp

Value: true|false. Optional. Defaults to false. If true, the [OP] sign will be added to the first thread post.

tripcode

Value: true|false. Optional. Defaults to false. If true and the hashpass cookie is not empty, the tripcode will be added to the post.

password

Password, which may be used to delete the thread later. Optional.

markupMode

Value: NONE|EXTENDED_WAKABA_MARK|BB_CODE|EXTENDED_WAKABA_MARK,BB_CODE. Optional. Defaults to NONE. The post text will be rendered using the specified markup mode.

file_<id>

File. Optional on some boards. <id> should be unique and correspond to the file_<id>_rating field. Files with no data (zero size) are ignored.

file_url_<id>

File URL. Optional on some boards. <id> should be unique and correspond to the file_<id>_rating field. Files specified by URLs will be downloaded on the server side. Files with no data (zero size) are ignored.

file_<id>_rating

Value: SFW|R-15|R-18|R-18G. Optional. Defaults to SFW. <id> must correspond to the file_<id> or file_url_<id> field.

Effect

Creates a new thread on the specified board.

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.

Move thread

Note: a user must have access level MODER or higher to move a thread.

Request

/action/moveThread

Fields

boardName

Name of the board of the target thread.

threadNumber

Numbr of the target thread.

targetBoardName

Name of the board to move the thread to.

password

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

Effect

Moves the specified thread to another board. Post numbers are changed, post links are changed, and attached files are moved. Post search index and other stuff are changed accordingly.

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.

Set thread fixed

Note: a user must have access level MODER or higher to make a thread fixed/not fixed.

/action/setThreadFixed

Fields

boardName

Name of the board of the target thread.

threadNumber

Numbr of the target thread.

fixed

Determines if a thread should be marked as fixed or not. Values: true|false (strings, not booleans, because HTTP POST does not support booleans).

Effect

Marks thr target thread as fixed or not fixed.

Result

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

Error

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

Set thread closed

Note: a user must have access level MODER or higher to make a thread closed/opened.

/action/setThreadClosed

Fields

boardName

Name of the board of the target thread.

threadNumber

Numbr of the target thread.

closed

Determines if a thread should be marked as closed or not. Values: true|false (strings, not booleans, because HTTP POST does not support booleans).

Effect

Marks the target thread as closed or not opened.

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.

Set thread unbumpable

Note: a user must have access level MODER or higher to make a thread unbumpable.

/action/setThreadUnbumpable

Fields

boardName

Name of the board of the target thread.

threadNumber

Numbr of the target thread.

unbumpable

Determines if a thread should be marked as unbumpable. Values: true|false (strings, not booleans, because HTTP POST does not support booleans).

Effect

Marks the target thread as unbumpable or bumpable. Unbumpable threads are not bumped on new posts.

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.

Clone this wiki locally