Projects API: Update check in
Endpoint#
Section titled “Endpoint#”| Property | Value |
|---|---|
| Type | mutation |
| Method | POST |
| Path | /api/external/v1/projects/update_check_in |
| Handler | OperatelyWeb.Api.Projects.UpdateCheckIn |
Authentication#
Section titled “Authentication#”- Requires a valid API token.
- Requires a write-enabled token.
- Read-only tokens return
403.
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
check_in_id | id primitive (encoded as string) | Yes | No | - |
status | project_check_in_status enum (on_track, caution, off_track) | Yes | No | - |
description | json primitive (encoded as string) | Yes | No | - |
state | check_in_state enum (draft, scheduled, published) | No | Yes | - |
scheduled_at | datetime | No | Yes | - |
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 |
|---|---|---|---|
check_in | project_check_in object | Yes | No |
cURL Example#
Section titled “cURL Example#”Copied
curl --request POST \
--url "https://app.operately.com/api/external/v1/projects/update_check_in" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
--header "Content-Type: application/json" \
--data '{"check_in_id":"value", "description":"value", "scheduled_at":"2026-01-01T09:30:00Z", "send_notifications_to_everyone":true, "state":"draft", "status":"on_track", "subscriber_ids":["value"]}'Response Example#
Section titled “Response Example#”{ "check_in": { "__typename": "value", "acknowledged_at": "2026-01-01T09:30:00Z", "acknowledged_by": "<person>", "author": "<person>", "comments_count": 123, "description": "value", "id": "value", "inserted_at": "2026-01-01", "notifications": [ "<notification>" ], "potential_subscribers": [ "<subscriber>" ], "project": "<project>", "published_at": "2026-01-01T09:30:00Z", "reactions": [ "<reaction>" ], "scheduled_at": "2026-01-01T09:30:00Z", "space": "<space>", "state": "draft", "status": "on_track", "subscription_list": "<subscription_list>", "updated_at": "2026-01-01" }}