--- title: Comment case description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Case Management --- # Comment case{% #comment-case %} {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/cases/{case_id}/comment | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/cases/{case_id}/comment | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/cases/{case_id}/comment | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/cases/{case_id}/comment | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/cases/{case_id}/comment | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/cases/{case_id}/comment | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/cases/{case_id}/comment | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/cases/{case_id}/comment | ### Overview Comment case ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------- | ------ | ------------------ | | case_id [*required*] | string | Case's UUID or key | ### Request #### Body Data (required) Case comment payload {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------------- | ------ | ------------------------------------------------------------- | | | data [*required*] | object | Case comment | | data | attributes [*required*] | object | Case comment attributes | | attributes | comment [*required*] | string | The `CaseCommentAttributes` `message`. | | data | type [*required*] | enum | JSON:API resource type for cases. Allowed enum values: `case` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "comment": "Hello World !" }, "type": "case" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing the chronological list of timeline cells for a case. | Parent field | Field | Type | Description | | ------------ | ---------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | [object] | The `TimelineResponse` `data`. | | data | attributes [*required*] | object | Attributes of a timeline cell, representing a single event in a case's chronological activity log (for example, a comment, status change, or assignment update). | | attributes | author | | The author of the timeline cell. Currently only user authors are supported. | | author | Option 1 | object | A user who authored a timeline cell. | | Option 1 | content | object | Profile information for the user who authored the timeline cell. | | content | email | string | The email address of the user. | | content | handle | string | The Datadog handle of the user. | | content | id | string | The UUID of the user. | | content | name | string | The display name of the user. | | Option 1 | type | enum | The type of timeline cell author. Currently only `USER` is supported. Allowed enum values: `USER` | | attributes | cell_content | | The content payload of a timeline cell, varying by cell type. | | cell_content | Option 1 | object | The content of a comment timeline cell. | | Option 1 | message | string | The text content of the comment. Supports Markdown formatting. | | attributes | created_at | date-time | Timestamp of when the cell was created | | attributes | deleted_at | date-time | Timestamp of when the cell was deleted | | attributes | modified_at | date-time | Timestamp of when the cell was last modified | | attributes | type | enum | The type of content in the timeline cell. Currently only `COMMENT` is supported in this endpoint. Allowed enum values: `COMMENT` | | data | id [*required*] | string | Timeline cell's identifier | | data | type [*required*] | enum | JSON:API resource type for timeline cells. Allowed enum values: `timeline_cell` | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "author": { "content": { "email": "string", "handle": "string", "id": "string", "name": "string" }, "type": "USER" }, "cell_content": { "message": "string" }, "created_at": "2019-09-19T10:00:00.000Z", "deleted_at": "2019-09-19T10:00:00.000Z", "modified_at": "2019-09-19T10:00:00.000Z", "type": "COMMENT" }, "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", "type": "timeline_cell" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export case_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de504" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/cases/${case_id}/comment" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "comment": "This is my comment !" }, "type": "case" } } EOF ##### ```go // Comment case returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // there is a valid "case" in the system CaseID := os.Getenv("CASE_ID") body := datadogV2.CaseCommentRequest{ Data: datadogV2.CaseComment{ Attributes: datadogV2.CaseCommentAttributes{ Comment: "Hello World !", }, Type: datadogV2.CASERESOURCETYPE_CASE, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewCaseManagementApi(apiClient) resp, r, err := api.CommentCase(ctx, CaseID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.CommentCase`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.CommentCase`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Comment case returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.CaseManagementApi; import com.datadog.api.client.v2.model.CaseComment; import com.datadog.api.client.v2.model.CaseCommentAttributes; import com.datadog.api.client.v2.model.CaseCommentRequest; import com.datadog.api.client.v2.model.CaseResourceType; import com.datadog.api.client.v2.model.TimelineResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); CaseManagementApi apiInstance = new CaseManagementApi(defaultClient); // there is a valid "case" in the system String CASE_ID = System.getenv("CASE_ID"); CaseCommentRequest body = new CaseCommentRequest() .data( new CaseComment() .attributes(new CaseCommentAttributes().comment("Hello World !")) .type(CaseResourceType.CASE)); try { TimelineResponse result = apiInstance.commentCase(CASE_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling CaseManagementApi#commentCase"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Comment case returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.case_management_api import CaseManagementApi from datadog_api_client.v2.model.case_comment import CaseComment from datadog_api_client.v2.model.case_comment_attributes import CaseCommentAttributes from datadog_api_client.v2.model.case_comment_request import CaseCommentRequest from datadog_api_client.v2.model.case_resource_type import CaseResourceType # there is a valid "case" in the system CASE_ID = environ["CASE_ID"] body = CaseCommentRequest( data=CaseComment( attributes=CaseCommentAttributes( comment="Hello World !", ), type=CaseResourceType.CASE, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = CaseManagementApi(api_client) response = api_instance.comment_case(case_id=CASE_ID, body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Comment case returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::CaseManagementAPI.new # there is a valid "case" in the system CASE_ID = ENV["CASE_ID"] body = DatadogAPIClient::V2::CaseCommentRequest.new({ data: DatadogAPIClient::V2::CaseComment.new({ attributes: DatadogAPIClient::V2::CaseCommentAttributes.new({ comment: "Hello World !", }), type: DatadogAPIClient::V2::CaseResourceType::CASE, }), }) p api_instance.comment_case(CASE_ID, body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Comment case returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI; use datadog_api_client::datadogV2::model::CaseComment; use datadog_api_client::datadogV2::model::CaseCommentAttributes; use datadog_api_client::datadogV2::model::CaseCommentRequest; use datadog_api_client::datadogV2::model::CaseResourceType; #[tokio::main] async fn main() { // there is a valid "case" in the system let case_id = std::env::var("CASE_ID").unwrap(); let body = CaseCommentRequest::new(CaseComment::new( CaseCommentAttributes::new("Hello World !".to_string()), CaseResourceType::CASE, )); let configuration = datadog::Configuration::new(); let api = CaseManagementAPI::with_config(configuration); let resp = api.comment_case(case_id.clone(), body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Comment case returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.CaseManagementApi(configuration); // there is a valid "case" in the system const CASE_ID = process.env.CASE_ID as string; const params: v2.CaseManagementApiCommentCaseRequest = { body: { data: { attributes: { comment: "Hello World !", }, type: "case", }, }, caseId: CASE_ID, }; apiInstance .commentCase(params) .then((data: v2.TimelineResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}