Skip to main content
POST
Comment on a roadmap item

Authorizations

Authorization
string
header
required

The session token of a signed-in Plazza account, sent as Authorization: Bearer <token>.

Path Parameters

board
enum<string>
required

The board: hire for employers, talents for job seekers.

Available options:
hire,
talents
Example:

"hire"

item
string<uuid>
required

The item's id.

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)$
Example:

"019a7c2e-4b1d-7c3a-9d4e-5f6a7b8c9d0e"

Query Parameters

requestId
string<uuid>

Makes a retry safe: a request with the same id and content returns the resource the first one created.

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)$
Example:

"0f5e8c1e-7a8b-4c2d-9e1f-2a3b4c5d6e7f"

Body

application/json

A comment on a roadmap item.

body
string
required

The text in Markdown, 1 to 10,000 characters.

Maximum string length: 50000
Example:

"Weโ€™d use this every week."

parent
string | null

To reply, the resource name of a top-level comment on the same item. Threads are one level deep.

Maximum string length: 300
Example:

null

displayName
string

The name shown with what you post. Kept with your first post or comment, and ignored after that: rename through your roadmap persona.

Maximum string length: 200
Example:

"Camille Tremblay"

Response

A comment on a roadmap item, or a reply to one. Threads are one level deep.

A comment on a roadmap item, or a reply to one. Threads are one level deep.

name
string
required

The comment's resource name.

Example:

"roadmapBoards/hire/items/019a7c2e-4b1d-7c3a-9d4e-5f6a7b8c9d0e/comments/019a7c31-0e2f-7a1b-8c3d-4e5f6a7b8c9d"

parent
string | null
required

The top-level comment it replies to. Null for a top-level comment.

Example:

null

source
enum<string>
required

LINEAR for a reply the Plazza team wrote in Linear.

Available options:
PLAZZA,
LINEAR
Example:

"PLAZZA"

body
string
required

The text, in Markdown. Empty once removed.

Example:

"Weโ€™d use this every week."

author
object | null
required

Who wrote it: a reply from Linear is the staff memberโ€™s. Null once removed.

Example:
reactions
object[]
required

Reactions, by emoji.

Example:
replyCount
integer
required

How many replies a top-level comment has, removed ones included.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

2

etag
string
required

AIP-154: send it back to change the comment.

Example:

"\"1\""

createTime
string<date-time>
required

When it was written.

Example:

"2026-11-05T09:12:44.031Z"

updateTime
string<date-time>
required

When it was last edited or removed.

Example:

"2026-11-05T09:12:44.031Z"

deleteTime
string<date-time> | null
required

AIP-164: when its author or staff removed it. Null otherwise.

Example:

"2026-11-05T09:12:44.031Z"