Goals API: Create discussion

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/goals/create_discussion
Handler	OperatelyWeb.Api.Goals.CreateDiscussion

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
goal_id	id primitive (encoded as string)	Yes	No	-
title	string	Yes	No	-
message	json primitive (encoded as string)	Yes	No	-
send_notifications_to_everyone	boolean	No	No	true
subscriber_ids	array of id primitive (encoded as string)	No	No	[]

Outputs#

Field	Type	Required	Nullable
discussion	comment_thread object	Yes	No
activity_id	string	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/goals/create_discussion" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"goal_id":"value", "message":"value", "send_notifications_to_everyone":true, "subscriber_ids":["value"], "title":"value"}'

Response Example#

{
  "activity_id": "value",
  "discussion": {
    "__typename": "value",
    "acknowledged_at": "2026-01-01T09:30:00Z",
    "acknowledged_by": "<person>",
    "author": "<person>",
    "can_comment": true,
    "comments": [
      "<comment>"
    ],
    "comments_count": 123,
    "id": "value",
    "inserted_at": "2026-01-01",
    "message": "value",
    "notifications": [
      "<notification>"
    ],
    "potential_subscribers": [
      "<subscriber>"
    ],
    "project": "<project>",
    "project_permissions": "<project_permissions>",
    "reactions": [
      "<reaction>"
    ],
    "space": "<space>",
    "subscription_list": "<subscription_list>",
    "title": "value"
  }
}