Goals API: Create check in

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/goals/create_check_in
Handler	OperatelyWeb.Api.Goals.CreateCheckIn

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
goal_id	id primitive (encoded as string)	Yes	No	-
status	goal_check_in_status enum (on_track, caution, off_track)	Yes	No	-
due_date	contextual_date object	No	Yes	-
checklist	array of goal_check_update object	No	No	-
content	json primitive (encoded as string)	Yes	No	-
new_target_values	string	No	No	-
post_as_draft	boolean	No	No	false
send_notifications_to_everyone	boolean	No	No	true
subscriber_ids	array of id primitive (encoded as string)	No	No	[]
scheduled_at	datetime	No	Yes	-

Outputs#

Field	Type	Required	Nullable
update	goal_progress_update object	No	Yes

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/goals/create_check_in" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"checklist":[{"completed":true, "id":"value", "index":123, "name":"value"}], "content":"value", "due_date":{"__typename":"value", "date":"2026-01-01", "date_type":"day", "value":"value"}, "goal_id":"value", "new_target_values":"value", "post_as_draft":true, "scheduled_at":"2026-01-01T09:30:00Z", "send_notifications_to_everyone":true, "status":"on_track", "subscriber_ids":["value"]}'

Response Example#

{
  "update": {
    "__typename": "value",
    "acknowledged": true,
    "acknowledged_at": "2026-01-01T09:30:00Z",
    "acknowledging_person": "<person>",
    "author": "<person>",
    "checklist": [
      "<goal_check_update>"
    ],
    "comments_count": 123,
    "goal": "<goal>",
    "goal_target_updates": [
      "<goal_target_updates>"
    ],
    "id": "value",
    "inserted_at": "2026-01-01T09:30:00Z",
    "message": "value",
    "notifications": [
      "<notification>"
    ],
    "permissions": "<goal_update_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "published_at": "2026-01-01T09:30:00Z",
    "reactions": [
      "<reaction>"
    ],
    "scheduled_at": "2026-01-01T09:30:00Z",
    "state": "draft",
    "status": "on_track",
    "subscription_list": "<subscription_list>",
    "timeframe": "<timeframe>",
    "updated_at": "2026-01-01T09:30:00Z"
  }
}