post

Overview

This endpoint is used for creating new comments. Currently, comments can only be added to organization members via the API, though this may be expanded in the future.

HTTP Request

POST /api/v1/organizations/:organizationName/members/:userName/comments

This endpoint extends the general API structure

Path parameters

Parameter	Type	Description
:organizationName	string	The name of the organization
:userName	string	The username of the particular member

This endpoint extends the general API structure.

Request body

Provide a JSON object with information about the comment.

Property name	Type	Description
text	string	Required. The text of the comment. May be up to 2048 characters.

Authorization

You must be an administrator of the requested organization, and your access token must have the following scope:

• organization.write

Learn more about authorization.

Response body

Returns the JSON-encoded "get" representation of a comment resource.