Creates a subscription to a block for a user. The user will receive change notifications for the block.

post/api/v1/workspaces/{workspaceID}/subscriptions

Path parameters

workspaceIDstring required

Workspace ID

blockIdstring required

BlockID is id of the entity being subscribed to

blockTypestring required

createAtinteger required

CreatedAt is the timestamp this subscription was created

deleteAtinteger required

DeleteAt is the timestamp this subscription was deleted, or zero if not deleted

notifiedAtinteger required

NotifiedAt is the timestamp of the last notification sent for this subscription

subscriberIdstring required

SubscriberID is the id of the entity that is subscribing

subscriberTypestring required

workspaceIdstring required

WorkspaceID is id of the workspace the block belongs to

success

create_atinteger required

Created time

delete_atinteger required

Deleted time, set to indicate user is deleted

idstring required

The user ID

is_botboolean required

If the user is a bot or not

propsobject required

User settings

update_atinteger required

Updated time

usernamestring required

The user name