goals/add_check

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/goals/add_check
Handler	OperatelyWeb.Api.GoalChecks.Add

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	-
name	string	Yes	No	-

Outputs#

Field	Type	Required	Nullable
check_id	id primitive (encoded as string)	Yes	No
success	boolean	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/goals/add_check" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"goal_id":"value", "name":"value"}'

Response Example#

{
  "check_id": "value",
  "success": true
}