Skip to content
BobaBoard Docs

Create a new thread.

POST
/boards/{board_id}

Creates a new thread in the specified board.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
board_id
required
string format: uuid

The id for the board in which the thread will be created.

Examples

The id for the gore board.

c6d3d10e-8e49-4d73-b28a-9d652b41beec

Request Body required

Section titled “Request Body required ”

Request body

object
content
required

The content of the first post in the thread.

string format: quill-delta
forceAnonymous
One of:
boolean
defaultView

The default view that the thread will display as.

string
Allowed values: thread gallery timeline
identityId

The identity the original poster will use to create the thread.

string format: uuid
accessoryId

The accessory that the original poster will use in the thread.

string format: uuid
whisper_tags

The whisper tags associated with the thread.

Array<string>
index_tags

The searchable tags associated with the thread.

Array<string>
content_warnings

The content warnings associated with the thread.

Array<string>
category_tags

The categories associated with the thread.

Array<string>
Examples

The request body for making a thread on the gore board.

{
  "content": "[{\"insert\":\"Gore. Gore? Gore!\"}]",
  "forceAnonymous": false,
  "defaultView": "thread",
  "whisper_tags": [
    "whisper"
  ],
  "index_tags": [
    "search"
  ],
  "content_warnings": [
    "content notice"
  ],
  "category_tags": [
    "filter"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Thread has been created.

object
posts
required
Array<object>

A contribution to a thread.

object
id
required
string format: uuid
parent_thread_id
required
string format: uuid
parent_post_id
required
One of:
string format: uuid
content
required
string format: quill-delta
created_at
required
string format: date-time
secret_identity
required

The public-facing identity associated with the contribution.

object
name
required
string
avatar
required
string format: uri-reference
color
One of:
string format: color
accessory
One of:
string format: uri-reference
user_identity
required
One of:
object
name
required
One of:
string
avatar
required
One of:
string format: uri-reference
new
required
boolean
own
required
boolean
friend
required
boolean
total_comments_amount
required
number
new_comments_amount
required
number
tags
required

Types of tags associated to a contribution.

object
whisper_tags
required
Array<string>
index_tags
required
Array<string>
category_tags
required
Array<string>
content_warnings
required
Array<string>
comments
required

A map from post_id to its comments.

object
key
additional properties
Array<object>
object
id
required
string format: uuid
parent_post_id
required
string format: uuid
parent_comment_id
required
One of:
string format: uuid
chain_parent_id
required
One of:
string format: uuid
content
required
string format: quill-delta
secret_identity
required

The public-facing identity associated with the comment.

object
name
required
string
avatar
required
string format: uri-reference
color
One of:
string format: color
accessory
One of:
string format: uri-reference
user_identity
required
One of:
object
name
required
One of:
string
avatar
required
One of:
string format: uri-reference
created_at
required
string format: date-time
own
required
boolean
new
required
boolean
friend
required
boolean
id
required
string format: uuid
parent_board_slug
required
string
parent_board_id
required
string
parent_realm_slug
required
string
parent_realm_id
required
string
starter
required

The contribution that starts the thread.

object
id
required
string format: uuid
parent_thread_id
required
string format: uuid
parent_post_id
required
One of:
string format: uuid
content
required
string format: quill-delta
created_at
required
string format: date-time
secret_identity
required

The public-facing identity associated with the contribution.

object
name
required
string
avatar
required
string format: uri-reference
color
One of:
string format: color
accessory
One of:
string format: uri-reference
user_identity
required
One of:
object
name
required
One of:
string
avatar
required
One of:
string format: uri-reference
new
required
boolean
own
required
boolean
friend
required
boolean
total_comments_amount
required
number
new_comments_amount
required
number
tags
required

Types of tags associated to a contribution.

object
whisper_tags
required
Array<string>
index_tags
required
Array<string>
category_tags
required
Array<string>
content_warnings
required
Array<string>
default_view
required
string
Allowed values: thread gallery timeline
new
required

Whether the thread is new. False when the user is logged out.

boolean
muted
required

Whether the thread is muted. False when the user is logged out.

boolean
hidden
required

Whether the thread is hidden. False when the user is logged out.

boolean
starred
required

Whether the thread is starred.

boolean
new_posts_amount
required
number
new_comments_amount
required
number
total_comments_amount
required
number
total_posts_amount
required
number
direct_threads_amount
required
number
last_activity_at
required
string format: date-time
Examples

The response body for making a thread on the gore board.

{
  "id": "60634506-6ab1-4083-9867-905cef85cef6",
  "parent_board_slug": "gore",
  "parent_board_id": "c6d3d10e-8e49-4d73-b28a-9d652b41beec",
  "parent_realm_slug": "twisted-minds",
  "parent_realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
  "starter": {
    "id": "30f7b263-2406-495a-8ab7-4bd559738510",
    "parent_thread_id": "60634506-6ab1-4083-9867-905cef85cef6",
    "parent_post_id": null,
    "created_at": "2021-11-15T13:32:26.00Z",
    "content": "[{\"insert\":\"Gore. Gore? Gore!\"}]",
    "secret_identity": {
      "name": "Him Free",
      "avatar": "https://firebasestorage.googleapis.com/v0/b/bobaboard-fb.appspot.com/o/images%2Fbobaland%2Fundefined%2F4e72a52a-9fdd-4a49-a7f0-ffa56a46836d?alt=media&token=153015fa-c46b-4184-a17f-10c3e609bf70",
      "color": null,
      "accessory": null
    },
    "user_identity": {
      "name": "bobatan",
      "avatar": "/bobatan.png"
    },
    "friend": false,
    "own": true,
    "new": false,
    "tags": {
      "whisper_tags": [
        "whisper"
      ],
      "index_tags": [
        "search"
      ],
      "category_tags": [
        "filter"
      ],
      "content_warnings": [
        "content notice"
      ]
    },
    "total_comments_amount": 0,
    "new_comments_amount": 0
  },
  "default_view": "thread",
  "muted": false,
  "hidden": false,
  "starred": false,
  "new": false,
  "new_posts_amount": 0,
  "new_comments_amount": 0,
  "total_comments_amount": 0,
  "total_posts_amount": 1,
  "last_activity_at": "2021-11-15T13:32:26.00Z",
  "direct_threads_amount": 0,
  "posts": [
    {
      "id": "30f7b263-2406-495a-8ab7-4bd559738510",
      "parent_thread_id": "60634506-6ab1-4083-9867-905cef85cef6",
      "parent_post_id": null,
      "created_at": "2021-11-15T13:32:26.00Z",
      "content": "[{\"insert\":\"Gore. Gore? Gore!\"}]",
      "secret_identity": {
        "name": "Him Free",
        "avatar": "https://firebasestorage.googleapis.com/v0/b/bobaboard-fb.appspot.com/o/images%2Fbobaland%2Fundefined%2F4e72a52a-9fdd-4a49-a7f0-ffa56a46836d?alt=media&token=153015fa-c46b-4184-a17f-10c3e609bf70",
        "color": null,
        "accessory": null
      },
      "user_identity": null,
      "friend": false,
      "own": true,
      "new": false,
      "tags": {
        "whisper_tags": [
          "whisper"
        ],
        "index_tags": [
          "search"
        ],
        "category_tags": [
          "filter"
        ],
        "content_warnings": [
          "content notice"
        ]
      },
      "total_comments_amount": 0,
      "new_comments_amount": 0
    }
  ],
  "comments": {
    "30f7b263-2406-495a-8ab7-4bd559738510": []
  }
}

401

Section titled “401 ”

User was not found in request that requires authentication.

Generic response object

object
message
string
Examples

No authentication token given.

{
  "message": "No authenticated user found."
}

403

Section titled “403 ”

User is unauthorized to perform board operation.

Generic response object

object
message
string
Examples

Insufficient permissions.

{
  "message": "User does not have required permissions for board operation."
}

404

Section titled “404 ”

The specified board could not be found.

Generic response object

object
message
string
Examples

Board not found.

{
  "message": "The board with id 29d1b2da-3289-454a-9089-2ed47db4967b was not found."
}