Create an API comment

Deprecated

POST

/apis/:apiId/comments

Creates a comment on an API. To create a reply on an existing comment, include the threadId property in the request body.

Note:

This endpoint accepts a max of 10,000 characters.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

apiIdstringRequired

The API's ID.

Request

This endpoint expects an object.

bodystringRequired

The contents of the comment.

threadIdintegerOptional

The comment's thread ID. To create a reply on an existing comment, include this property.

tagsobjectOptional

Information about users tagged in the body comment.

Response

Created

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/comments \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"body": "This is an example."
>	}'

1	{
2	"data": {
3	"id": 46814,
4	"threadId": 12345,
5	"createdBy": 12345678,
6	"createdAt": "2024-01-18T11:30:40.000Z",
7	"updatedAt": "2024-01-18T11:30:40.000Z",
8	"body": "This is an example.",
9	"status": "Open"
10	}
11	}