Add Work Pulse Note

POST

/work/pulse

• Production
• QA

Post one pulse update — the room’s org-wide, channel-less status note.

replyToEventId threads it under an existing note.

Authorizations

• BearerAuth

Parameters

Header Parameters

Idempotency-Key

Any of:

string

string

null

null

Retry-safety key. Replaying one returns the ORIGINAL result with duplicate: true instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry.

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

One pulse update — the room’s org-wide, channel-less status note.

object

content

required

string

>= 1 characters <= 2000 characters

replyToEventId

Any of:

string

string

<= 128 characters

null

null

Responses

201

Successful Response

object

data

required

One posted pulse update.

object

duplicate

Any of:

boolean

boolean

null

null

event

Any of:

object

object

key

additional properties

any

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string