Skip to content
BobaBoard Docs

Update board metadata

PATCH
/boards/{board_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

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

The external id of the board to update metadata for.

Examples

An existing board (gore)

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

Request Body

Section titled “Request Body ”

Request body

object
descriptions

Array of updated description objects.

Array
One of: discriminator: type
object
id
required
string format: uuid
index
required
number
title
required
string
type
required
string
Allowed values: text
description
required
string
accentColor

Board accent color.

string
tagline

Board tagline.

string
Examples

Update metadata for the gore board.

{
  "descriptions": [
    {
      "id": "680ca4ba-87b5-479c-8b1f-3b674900331a",
      "type": "text",
      "index": 1,
      "title": "gore description",
      "description": "[{\"insert\": \"pls b nice\"}]"
    },
    {
      "id": "1f256747-3bd5-41c0-b9a2-760241bd7928",
      "type": "category_filter",
      "index": 2,
      "title": "gore Categories",
      "categories": [
        "blood",
        "bruises"
      ],
      "description": null
    },
    {
      "id": "68f77b6b-3ac9-40f2-8507-7fed90c0da82",
      "index": 3,
      "title": "test2",
      "type": "text",
      "description": "[{\"insert\":\"test\\n\"}]"
    }
  ],
  "accentColor": "#f68298",
  "tagline": "Blood! Blood! BLOOD."
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The board metadata.

object
id
required
string format: uuid
realm_id
required
string
slug
required
string
avatar_url
required
string format: uri-reference
tagline
required
string
accent_color
required
string
logged_in_only
required
boolean
delisted
required
boolean
muted
required
boolean
pinned
required
boolean
id
required
string format: uuid
realm_id
required
string
slug
required
string
avatar_url
required
string format: uri-reference
tagline
required
string
accent_color
required
string
logged_in_only
required
boolean
delisted
required
boolean
descriptions
required
Array
One of: discriminator: type
object
id
required
string format: uuid
index
required
number
title
required
string
type
required
string
Allowed values: text
description
required
string
accessories
required
Array<object>
object
id
required
string format: uuid
name
required
string
accessory
required
string format: uri-reference
permissions
required
object
board_permissions
required
Array<string>
Allowed values: edit_board_details view_roles_on_board
post_permissions
required
Array<string>
Allowed values: edit_content edit_whisper_tags edit_category_tags edit_index_tags edit_content_notices
thread_permissions
required
Array<string>
Allowed values: move_thread
posting_identities
required
Array<object>
object
id
required
string format: uuid
name
required
string
avatar_url
string format: uri-reference
color
One of:
string format: color
accessory
One of:
string format: uri
Examples

Updated metadata for the gore board.

{
  "id": "c6d3d10e-8e49-4d73-b28a-9d652b41beec",
  "realm_id": "f377afb3-5c62-40cc-8f07-1f4749a780eb",
  "slug": "gore",
  "accent_color": "#f68298",
  "tagline": "Blood! Blood! BLOOD.",
  "avatar_url": "/gore.png",
  "delisted": false,
  "logged_in_only": false,
  "muted": false,
  "pinned": false,
  "descriptions": [
    {
      "id": "68f77b6b-3ac9-40f2-8507-7fed90c0da82",
      "type": "text",
      "index": 3,
      "title": "test2",
      "description": "[{\"insert\":\"test\\n\"}]"
    },
    {
      "id": "680ca4ba-87b5-479c-8b1f-3b674900331a",
      "type": "category_filter",
      "index": 2,
      "title": "gore Categories",
      "categories": [
        "blood",
        "bruises"
      ],
      "description": null
    },
    {
      "id": "68f77b6b-3ac9-40f2-8507-7fed90c0da82",
      "type": "text",
      "index": 1,
      "title": "gore description",
      "description": "[{\"insert\": \"pls b nice\"}]"
    }
  ],
  "permissions": {
    "board_permissions": [
      "edit_board_details"
    ],
    "post_permissions": [
      "edit_category_tags",
      "edit_content_notices"
    ],
    "thread_permissions": [
      "move_thread"
    ]
  },
  "posting_identities": [
    {
      "id": "3df1d417-c36a-43dd-aaba-9590316ffc32",
      "name": "The Owner",
      "color": "pink",
      "accessory": "https://firebasestorage.googleapis.com/v0/b/bobaboard-fb.appspot.com/o/images%2Fbobaland%2Fc26e8ce9-a547-4ff4-9486-7a2faca4d873%2F7c6c9459-7fa1-4d06-8dc0-ebb5b1bd76a8.png?alt=media&token=78d812a5-b217-4afb-99f3-41b9ed7b7ed5",
      "avatar": "https://firebasestorage.googleapis.com/v0/b/bobaboard-fb.appspot.com/o/images%2Fbobaland%2Fundefined%2F2df7dfb4-4c64-4370-8e74-9ee30948f05d?alt=media&token=26b16bef-0fd2-47b5-b6df-6cf2799010ca"
    },
    {
      "id": "e5f86f53-6dcd-4f15-b6ea-6ca1f088e62d",
      "name": "GoreMaster5000",
      "color": "red",
      "accessory": null,
      "avatar": "https://firebasestorage.googleapis.com/v0/b/bobaboard-fb.appspot.com/o/images%2Fbobaland%2Fc26e8ce9-a547-4ff4-9486-7a2faca4d873%2F6518df53-2031-4ac5-8d75-57a0051ed924?alt=media&token=23df54b7-297c-42ff-a0ea-b9862c9814f8"
    }
  ],
  "accessories": [
    {
      "id": "7071e443-4168-4afa-9454-871c48e59701",
      "name": "Rolling",
      "accessory": "/420accessories/weed_hands.png"
    },
    {
      "id": "e495f6cc-f313-4cc4-9882-f8ac89e8c2e4",
      "name": "Joint",
      "accessory": "/420accessories/joint.png"
    }
  ]
}

401

Section titled “401 ”

User was not found.

string
Example
Unauthorized

403

Section titled “403 ”

User is not authorized to update the metadata of this board.

string
Example
Forbidden

404

Section titled “404 ”

The board was not found.

string
Example
Not Found