Goals API: Create

Endpoint#

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

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
space_id	id primitive (encoded as string)	Yes	No	-
name	string	Yes	No	-
champion_id	id primitive (encoded as string)	No	Yes	-
reviewer_id	id primitive (encoded as string)	No	Yes	-
timeframe	timeframe object	No	Yes	-
targets	array of create_target_input object	No	Yes	-
description	json primitive (encoded as string)	No	Yes	-
parent_goal_id	id primitive (encoded as string)	No	Yes	-
anonymous_access_level	access_options_int enum (0, 10, 40, 70, 100)	Yes	No	-
company_access_level	access_options_int enum (0, 10, 40, 70, 100)	Yes	No	-
space_access_level	access_options_int enum (0, 10, 40, 70, 100)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
goal	goal object	No	Yes

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/goals/create" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"anonymous_access_level":"<access_options_int>", "champion_id":"value", "company_access_level":"<access_options_int>", "description":"value", "name":"value", "parent_goal_id":"value", "reviewer_id":"value", "space_access_level":"<access_options_int>", "space_id":"value", "targets":[{"from":12.34, "index":123, "name":"value", "to":12.34, "unit":"value"}], "timeframe":{"__typename":"value", "contextual_end_date":{"__typename":"value", "date":"2026-01-01", "date_type":"day", "value":"value"}, "contextual_start_date":{"__typename":"value", "date":"2026-01-01", "date_type":"day", "value":"value"}}}'

Response Example#

{
  "goal": {
    "__typename": "value",
    "access_levels": "<access_levels>",
    "archived_at": "2026-01-01",
    "champion": "<person>",
    "checklist": [
      "<goal_check>"
    ],
    "closed_at": "2026-01-01",
    "closed_by": "<person>",
    "description": "value",
    "id": "value",
    "inserted_at": "2026-01-01",
    "is_archived": true,
    "is_closed": true,
    "is_outdated": true,
    "last_check_in": "<goal_progress_update>",
    "last_check_in_id": "value",
    "my_role": "value",
    "name": "value",
    "next_update_scheduled_at": "2026-01-01",
    "notifications": [
      "<notification>"
    ],
    "parent_goal": "<goal>",
    "parent_goal_id": "value",
    "permissions": "<goal_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "privacy": "public",
    "progress_percentage": 12.34,
    "projects": [
      "<project>"
    ],
    "resource_hub": "<resource_hub>",
    "retrospective": "<goal_retrospective>",
    "reviewer": "<person>",
    "space": "<space>",
    "status": "on_track",
    "success": true,
    "targets": [
      "<target>"
    ],
    "timeframe": "<timeframe>",
    "updated_at": "2026-01-01",
    "url": "value"
  }
}