Skip to content

reopen_goal

Endpoint#

PropertyValue
Typemutation
MethodPOST
Path/api/external/v1/reopen_goal
HandlerOperatelyWeb.Api.Mutations.ReopenGoal

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
idid primitive (encoded as string)NoYes-
messagestringNoYes-
send_notifications_to_everyonebooleanNoYes-
subscriber_idsarray of id primitive (encoded as string)NoYes-

Outputs#

FieldTypeRequiredNullable
goalgoal objectNoYes

cURL Example#

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

Response Example#

{
  "goal": {
    "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>"
    ],
    "retrospective": "<goal_retrospective>",
    "reviewer": "<person>",
    "space": "<space>",
    "status": "on_track",
    "success": true,
    "targets": [
      "<target>"
    ],
    "timeframe": "<timeframe>",
    "updated_at": "2026-01-01"
  }
}