close_project

Endpoint#

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

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
project_id	id primitive (encoded as string)	Yes	No	-
retrospective	string	Yes	No	-
success_status	string	Yes	No	-
send_notifications_to_everyone	boolean	No	No	-
subscriber_ids	array of id primitive (encoded as string)	No	No	-

Outputs#

Field	Type	Required	Nullable
retrospective	project_retrospective object	Yes	No

cURL Example#

Copied

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

Response Example#

{
  "retrospective": {
    "author": "<person>",
    "closed_at": "2026-01-01",
    "content": "value",
    "id": "value",
    "notifications": [
      "<notification>"
    ],
    "permissions": "<project_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "project": "<project>",
    "reactions": [
      "<reaction>"
    ],
    "subscription_list": "<subscription_list>"
  }
}