---
title: "Comment on a check-in"
method: POST
path: "/check-ins/{check_in_id}/comments"
tags: ["Comments & Reactions"]
---

# Comment on a check-in

`POST /check-ins/{check_in_id}/comments`

## Request

- Base URL: `https://service.steady.space/api/v2`
- URL: `https://service.steady.space/api/v2/check-ins/{check_in_id}/comments`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://app.steady.space/oauth/authorize`, token URL `https://app.steady.space/oauth/token`)
  - HTTP bearer

## Request body

- Comment
  - `type` 'comment'
  - `id` string, uuid, required
  - `body` string, required: Comment body rendered as Markdown.
  - `person` PersonRef, required
    - `id` string, uuid, required
    - `name` string, required
  - `resource` ResourceRef, required: Reference to a related resource by `type` and `id`.
    - `type` 'check-in' | 'goal-update', required
    - `id` string, uuid, required
  - `created_at` string, date-time, required

## Response `201`

The created comment.

- Comment
  - `type` 'comment'
  - `id` string, uuid, required
  - `body` string, required: Comment body rendered as Markdown.
  - `person` PersonRef, required
    - `id` string, uuid, required
    - `name` string, required
  - `resource` ResourceRef, required: Reference to a related resource by `type` and `id`.
    - `type` 'check-in' | 'goal-update', required
    - `id` string, uuid, required
  - `created_at` string, date-time, required

## Other responses

- `<<`

---

[API](https://skmtc.dev/statushero/apis/steady-v2-rest-api.md) · [All operations](https://skmtc.dev/statushero/apis/steady-v2-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/statushero/apis/steady-v2-rest-api/revisions/a3ee255356cd?raw)