post/commentsWrite operation

Create a target comment

Creates plain-text product comments with canonical active-member mentions. Attachments and rich internal payloads are not accepted.

Required scopes

comments:write

Conditional scopes

contacts:readprojects:readtasks:read

Request example

curl --request POST \
  --url 'https://api.de.teamgrid.app/v1/comments' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "targetId": "string",
    "targetType": "contact",
    "text": "string"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/comments', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "targetId": "string",
  "targetType": "contact",
  "text": "string"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/comments', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "targetId": "string",
  "targetType": "contact",
  "text": "string"
}),
})

const result: ApiResponse = await response.json()

teamgrid comments create \
  --data @payload.json \
  --idempotency-key REQUEST_KEY

Example response 2xx

{
  "data": {
    "attributes": {
      "archived": false,
      "authorId": null,
      "createdAt": "2026-07-29T09:00:00.000Z",
      "revision": "example",
      "target": {
        "id": "string",
        "type": "contact"
      },
      "text": "string",
      "updatedAt": "2026-07-29T09:00:00.000Z"
    },
    "id": "string",
    "type": null
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

Idempotency-Keyheader · required

JSON request bodyValid JSON

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Headers

Idempotency-Keyrequired

string

Unique request key retained for seven days. Within that window, reuse with different data is rejected.

Request body

application/json

targetIdrequired

string

Identifier of the target resource.

targetTyperequired

string

Canonical type of the target resource.

contactprojecttask

textrequired

string

The text associated with this comment.

Responses

201The request to create a target comment created the resource. The response contains its canonical public representation and request metadata.application/json

Response schemaapplication/json

required

Comment

Public API representation of comment.

required

ResponseMeta

Public API representation of meta.

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

409The request conflicts with the current resource state.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDcreateCommentOpenAPI JSON ↗

Documentation feedbackWas this page useful?