Goals API: Reopen
Endpoint#
Section titled “Endpoint#”| Property | Value |
|---|---|
| Type | mutation |
| Method | POST |
| Path | /api/external/v1/goals/reopen |
| Handler | OperatelyWeb.Api.Goals.Reopen |
Authentication#
Section titled “Authentication#”- Requires a valid API token.
- Requires a write-enabled token.
- Read-only tokens return
403.
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
id | id primitive (encoded as string) | Yes | No | - |
message | json primitive (encoded as string) | Yes | No | - |
send_notifications_to_everyone | boolean | No | Yes | - |
subscriber_ids | array of id primitive (encoded as string) | No | Yes | - |
Outputs#
Section titled “Outputs#”| Field | Type | Required | Nullable |
|---|---|---|---|
goal | goal object | Yes | No |
cURL Example#
Section titled “cURL Example#”Copied
curl --request POST \
--url "https://app.operately.com/api/external/v1/goals/reopen" \
--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#
Section titled “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" }}