OFofficernd
Ticket Comments

Post a comment/comments about a specific ticket

Post a comment/comments about a specific ticket

Required scopes: flex.collaboration.ticketComments.create

post/api/v2/organizations/{orgSlug}/ticket-comments/{ticketId}

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/ticket-comments/{ticketId}
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.collaboration.ticketComments.create

Path parameters

ticketIdstring required

ticket id

orgSlugstring required

organization slug

Request body

textstring required

The text of the comment.

memberstring required

The member that posts the comment.

isPublicboolean required

Boolean that shows whether the comment is public. Comments coming from members can only have public set to "true".

Example request

{
  "text": "This is the comment text",
  "member": "6a4e2038aedbb38ad5b3f718",
  "isPublic": true
}

Response

_idstring

The _id of the item.

textstring

The text of the comment.

targetstring

The _id of the target item.

targetType'team' | 'member' | 'payment' | 'issue'

The type of the target item.

memberstring

The _id of the member who posted the comment.

isPublicboolean

Boolean that shows whether the comment is public.

Example response

{
  "_id": "6a4e2038aedbb38ad5b3f719",
  "text": "This is the comment text",
  "target": "6a4e2038aedbb38ad5b3f71a",
  "member": "6a4e2038aedbb38ad5b3f71b",
  "isPublic": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.