Create a workflow comment

POST

https://api.contentful.com/spaces/:space_id/environments/:environment_id/workflows/:workflow_id/versions/:version/comments

POST

/spaces/:space_id/environments/:environment_id/workflows/:workflow_id/versions/:version/comments

$ curl -X POST https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/workflows/fh6dsmnLKsh468/versions/2/comments \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/vnd.contentful.management.v1+json" \
>      -d '{
>   "body": "My first workflow comment"
> }'

201Workflow Comments_createAWorkflowComment_example

1 {
2   "body": "My first workflow comment",
3   "sys": {
4     "id": "someCommentId",
5     "type": "Comment",
6     "environment": {
7       "sys": {
8         "id": "staging",
9         "linkType": "Environment",
10         "type": "Link"
11       }
12     },
13     "space": {
14       "sys": {
15         "id": "yadj1kx9rmg0",
16         "linkType": "Space",
17         "type": "Link"
18       }
19     },
20     "parentEntity": {
21       "sys": {
22         "type": "Link",
23         "linkType": "Workflow",
24         "id": "fh6dsmnLKsh468",
25         "version": 7
26       }
27     },
28     "parent": "null",
29     "createdAt": "2025-01-31T20:50:17.000Z",
30     "createdBy": {
31       "sys": {
32         "linkType": "AppDefinition",
33         "id": "99SummRPRBowauM8T5Ljb34",
34         "type": "Link"
35       }
36     },
37     "updatedAt": "2025-04-07T00:06:05.000Z",
38     "updatedBy": {
39       "sys": {
40         "linkType": "User",
41         "id": "1xGZIRXr2WPnsLkKfREo0z",
42         "type": "Link"
43       }
44     },
45     "version": 1
46   }
47 }

Creates a comment for a specific workflow version; only one comment per version is supported. Accessible to any user with read access to workflows.

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

workflow_idstringRequired

ID of the workflow in form of a string

versionintegerRequired

Version number of the workflow

Request

This endpoint expects a map from strings to any.

Response headers

Content-Typestring

Content-Type

Response

Created - Resource created successfully