Skip to main content
PATCH
Update a room block

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
subUuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
block_type
enum<string>
Available options:
text,
image,
video,
document,
embed,
introduction,
action_bar,
banner,
lead_deal_analytics,
goals,
link,
advanced_search,
files,
pricing_calculator,
partner_details
label
string | null
content
object

Block content. See create block for shape per block_type.

series
number
block_settings
object

Block-type-specific settings. Only the key matching the block_type is relevant: action_bar blocks use action_bar, goals blocks use goals, banner blocks use banner, etc.

asset_uuid
string | null
markdown
string

Markdown content for text blocks. When provided, converts to TipTap JSON and overrides the content field.

Maximum string length: 100000

Response

200 - application/json

Default Response

uuid
string
required
block_type
enum<string>
required
Available options:
text,
image,
video,
document,
embed,
introduction,
action_bar,
banner,
lead_deal_analytics,
goals,
link,
advanced_search,
files,
pricing_calculator,
partner_details
label
string | null
required
series
number
required

Display order (1-indexed)

content
any
required

Block content — shape varies by block_type. See documentation.

block_settings
object
required

Block-type-specific settings. Only the key matching the block_type is relevant: action_bar blocks use action_bar, goals blocks use goals, banner blocks use banner, etc.

asset_uuid
string | null
required

Associated asset (image, video file, document, etc.)

created_at
string
required
updated_at
string
required