Skip to content

edit_project_retrospective

Endpoint#

PropertyValue
Typemutation
MethodPOST
Path/api/external/v1/edit_project_retrospective
HandlerOperatelyWeb.Api.Mutations.EditProjectRetrospective

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
idid primitive (encoded as string)YesNo-
contentstringYesNo-
success_statusstringYesNo-

Outputs#

FieldTypeRequiredNullable
retrospectiveproject_retrospective objectYesNo

cURL Example#

Copied
curl --request POST \
  --url "https://app.operately.com/api/external/v1/edit_project_retrospective" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"content":"value", "id":"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>"
  }
}