Skip to main content
PATCH
Edit a comment

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

comment_id
string
required

Body

application/json
value
string
required

The comment's text, up to 10,000 characters. Mention a person with the app's markup, [@Name](user:): a user's id, or a contact's

Required string length: 1 - 10000

Response

200 - application/json

Successful Response

author
string | null
required

The author's person id

author_name
string | null
required
author_type
enum<string> | null
required

user (a person), stella (Statisfy AI) or workflow (an automation)

Available options:
user,
stella,
workflow
created_at
string<date-time> | null
required
id
string
required
mentions
string[]
required

The ids of the people the text mentions, in order, each once

project
string | null
required

The id of the project the comment is on; null on a task comment

synced
boolean
required

True when the comment came from a tool synced with the task, such as Jira

task
string | null
required

The id of the task the comment is on; null on a project comment

updated_at
string<date-time> | null
required
value
string
required

The text, with its mentions as [@Name](user:)

visibility
enum<string>
required

internal (your team only, the default) or external (also shown in the customer's portal)

Available options:
internal,
external