create_goal_discussion

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/create_goal_discussion
Handler	OperatelyWeb.Api.Mutations.CreateGoalDiscussion

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)	No	Yes	-
title	string	No	Yes	-
message	string	No	Yes	-
send_notifications_to_everyone	boolean	No	Yes	-
subscriber_ids	array of id primitive (encoded as string)	No	Yes	-

Outputs#

Field	Type	Required	Nullable
id	string	No	Yes

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/create_goal_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#

{
  "id": "value"
}