Create a comment

POST

https://api.contentful.com/spaces/:space_id/environments/:environment_id/entries/:entry_id/comments

POST

/spaces/:space_id/environments/:environment_id/entries/:entry_id/comments

$ curl -X POST https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/entries/5KsDBWseXY6QegucYAoacS/comments \
>      -H "X-Contentful-Parent-Entity-Reference: fields.description.en-US" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/vnd.contentful.management.v1+json" \
>      -d '{
>   "body": "Looks good to me!",
>   "status": "active"
> }'

201Entry comments_createAComment_example

1 {
2   "body": "Looks good to me!",
3   "status": "active",
4   "sys": {
5     "id": "<comment_id>",
6     "type": "Comment",
7     "parentEntity": {
8       "sys": {
9         "type": "Link",
10         "linkType": "Entry",
11         "id": "5KsDBWseXY6QegucYAoacS"
12       }
13     },
14     "parent": {
15       "sys": {
16         "type": "Link",
17         "linkType": "Comment",
18         "id": "<comment_id>",
19         "ref": "fields.description.en"
20       }
21     },
22     "version": 1,
23     "space": {
24       "sys": {
25         "type": "Link",
26         "linkType": "Space",
27         "id": "yadj1kx9rmg0"
28       }
29     },
30     "environment": {
31       "sys": {
32         "type": "Link",
33         "linkType": "Environment",
34         "id": "staging"
35       }
36     },
37     "createdAt": "2025-02-22T18:52:56.000Z",
38     "createdBy": {
39       "sys": {
40         "type": "Link",
41         "linkType": "User",
42         "id": "7BslKh9TdKGOK41VmLDjFZ"
43       }
44     },
45     "updatedAt": "2025-02-22T18:52:56.000Z",
46     "updatedBy": {
47       "sys": {
48         "type": "Link",
49         "linkType": "User",
50         "id": "4FLrUHftHW3v2BLi9fzfjU"
51       }
52     }
53   }
54 }

Creates a comment on an entry with an auto-generated ID; limit is 100 comments per entry. Use X-Contentful-Parent-Id to reply to a specific comment.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

space_idstringRequired

ID of the space in form of a string

environment_idstringRequired

ID of the environment in form of a string

entry_idstringRequired

ID of the entry in form of a string

Headers

X-Contentful-Parent-IdstringOptional

Comment ID to reply to (creates a reply to the specified comment)

X-Contentful-Parent-Entity-ReferencestringOptional

Reference to a specific field and locale of the entry (must match pattern fields.<field_id>.<locale_code>)

Request

This endpoint expects a map from strings to any.

Response headers

Content-Typestring

Content-Type

Response

Created - Resource created successfully