patch /v1/blocks/{blockId}

Update a block

Applies a partial update to a block, changing exactly one property per request. Supports space-member sharing, hiding, and unhiding. A block is hidden once hide_after has passed and shown again once unhide_after has passed. To hide a block immediately set hide_after to the current time; to show it again set unhide_after to the current time. Use spaceMemberSharingLevel to set access for members of the block's own space on this block and its descendants; use BLOCK_SHARING_LEVEL_NOT_SHARED to disable that access. Exactly one field must be provided.

path params

blockIdstring required

Request body

hideAfter String Time after which the block becomes hidden. Set to the current time to hide the block immediately.

unhideAfter String Time after which the block becomes visible again. Set to the current time to show a hidden block immediately.

spaceMemberSharingLevel String ENUM

SPACEMEMBERSHARINGLEVEL ENUM VALUES

Responses

response body

object

block Object

BLOCK PROPERTIES

id String

descriptionSpaceId String

homeSpaceId String

attachedToMessageId String

parentBlockId String

type String ENUM

TYPE ENUM VALUES

BLOCK_TYPE_UNSPECIFIED BLOCK_TYPE_PAGE BLOCK_TYPE_SECTION BLOCK_TYPE_HEADING BLOCK_TYPE_TEXT BLOCK_TYPE_BULLETED_LIST_ITEM BLOCK_TYPE_NUMBERED_LIST_ITEM BLOCK_TYPE_FILE BLOCK_TYPE_IMAGE BLOCK_TYPE_CHECKBOX_LIST_ITEM BLOCK_TYPE_CALLOUT BLOCK_TYPE_QUOTE BLOCK_TYPE_DIVIDER BLOCK_TYPE_EMBED BLOCK_TYPE_LINK_PREVIEW BLOCK_TYPE_TABLE BLOCK_TYPE_BUTTON BLOCK_TYPE_CODE BLOCK_TYPE_VIDEO BLOCK_TYPE_AUDIO BLOCK_TYPE_SYNCED_BLOCK BLOCK_TYPE_TABLE_OF_CONTENTS BLOCK_TYPE_CALENDAR BLOCK_TYPE_TEMPLATE BLOCK_TYPE_WORKFLOW BLOCK_TYPE_ROOM BLOCK_TYPE_EVENT BLOCK_TYPE_POLL BLOCK_TYPE_AUDIO_MESSAGE BLOCK_TYPE_VIDEO_MESSAGE BLOCK_TYPE_CANVAS BLOCK_TYPE_FIND_A_TIME BLOCK_TYPE_FORM BLOCK_TYPE_GOAL BLOCK_TYPE_DATABASE BLOCK_TYPE_DATABASE_ITEM BLOCK_TYPE_CHART BLOCK_TYPE_ASSIGNMENT BLOCK_TYPE_QUIZ BLOCK_TYPE_RUBRIC BLOCK_TYPE_GRADES BLOCK_TYPE_PARAGRAPH BLOCK_TYPE_SLIDES BLOCK_TYPE_SLIDE

richContent String

icon String

createdBy String

updatedBy String

vOrder Number

hOrder Number

vOrderV2 String

hOrderV2 String

hideAfter String

unhideAfter String

startAt String

endAt String

isLocked Boolean

allowResponsesStart String

allowResponsesEnd String

responsesAreEditable Boolean

url String

defaultLayout String ENUM

DEFAULTLAYOUT ENUM VALUES

templateType String ENUM

TEMPLATETYPE ENUM VALUES

mediaThumbnailTime Number

programmingLanguage String

overrideDisplayNumber Boolean

publicAllowDuplicateAsTemplate Boolean

publicLinkExpiresAt String

publicSharingLevel String ENUM

PUBLICSHARINGLEVEL ENUM VALUES

organizationSharingLevel String ENUM

ORGANIZATIONSHARINGLEVEL ENUM VALUES

spaceMemberSharingLevel String ENUM

SPACEMEMBERSHARINGLEVEL ENUM VALUES

updatedAt String

createdAt String

deletedAt String

deletedBy String

jwtToken String

pilotToken String

correspondingRoomId String

userIsComplete Boolean Block user data

lastUserViewId String

lastSeenInfo Array

Array of LastSeenInfo

content String

ancestors Array

Array of BlockAncestor

attachments Array

Array of BlockAttachment

blockData Array

Array of BlockData

id String

blockId String

type String ENUM

TYPE ENUM VALUES

plainTextContent String

propertyValueDetail Object Kept as property_value_detail for wire-compatibility.

eventAttendanceDetail Object

goalCycleDefinitionDetail Object

createdAt String

updatedAt String

deletedAt String

relatedViewId String

parentBlockDataId String

createdById String

updatedById String

vOrder Number

vOrderV2 String Fractional-index ordering key (base-62) for position_in_view rows.

views Array

Array of BlockView

currentUserAccessLevel String ENUM

CURRENTUSERACCESSLEVEL ENUM VALUES

richTextCrdtVersion Integer

Pivot Desktop App

The Infinite Canvas Block

Audio and Video Messages

Making the Most of Your Personal Space

Integrating with Pivot using Zapier

Update a block

path params

Request body

Responses