Version 4.0.24.18 (latest)
Update a board definition.
Request
PATCH
/boards/{board_id}
Datatype
Description
Request
path
Expand HTTP Path definition...
board_id
Id of board
body
Expand HTTP Body definition...
body
Board
Expand Board definition...
can
lock
Operations the current user is able to perform on this object
content_metadata_id
lock
Id of associated content_metadata record
created_at
lock
Date of board creation
deleted_at
Date of board deletion
description
Description of the board
board_sections
id
lock
Unique Id
section_order
title
Title of the board
updated_at
lock
Date of last board update
user_id
lock
User id of board creator
primary_homepage
lock
Whether the board is the primary homepage or not
query
Expand HTTP Query definition...
fields
Requested fields.
Response
200: Board
Datatype
Description
(object)
can
lock
Operations the current user is able to perform on this object
content_metadata_id
lock
Id of associated content_metadata record
created_at
lock
Date of board creation
deleted_at
Date of board deletion
description
Description of the board
board_sections
Expand BoardSection definition...
can
lock
Operations the current user is able to perform on this object
created_at
lock
Time at which this section was created.
deleted_at
Time at which this section was deleted.
description
Description of the content found in this section.
board_id
Id reference to parent board
board_items
Expand BoardItem definition...
can
lock
Operations the current user is able to perform on this object
content_created_by
lock
Name of user who created the content this item is based on
content_favorite_id
lock
Content favorite id associated with the item this content is based on
content_metadata_id
lock
Content metadata id associated with the item this content is based on
content_updated_at
lock
Last time the content that this item is based on was updated
custom_description
Custom description entered by the user, if present
custom_title
Custom title entered by the user, if present
custom_url
Custom url entered by the user, if present
dashboard_id
Dashboard to base this item on
description
lock
The actual description for display
favorite_count
lock
Number of times content has been favorited, if present
board_section_id
Associated Board Section
id
lock
Unique Id
image_url
lock
The actual image_url for display
location
lock
The container folder name of the content
look_id
Look to base this item on
lookml_dashboard_id
LookML Dashboard to base this item on
order
An arbitrary integer representing the sort order within the section
title
lock
The actual title for display
url
lock
Relative url for the associated content
use_custom_description
Whether the custom description should be used instead of the content description, if the item is associated with content
use_custom_title
Whether the custom title should be used instead of the content title, if the item is associated with content
use_custom_url
Whether the custom url should be used instead of the content url, if the item is associated with content
view_count
lock
Number of times content has been viewed, if present
custom_image_data_base64
(Write-Only) base64 encoded image data
custom_image_url
lock
Custom image_url entered by the user, if present
use_custom_image
Whether the custom image should be used instead of the content image, if the item is associated with content
id
lock
Unique Id
item_order
visible_item_order
title
Name of row
updated_at
lock
Time at which this section was last updated.
id
lock
Unique Id
section_order
title
Title of the board
updated_at
lock
Date of last board update
user_id
lock
User id of board creator
primary_homepage
lock
Whether the board is the primary homepage or not
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link