Create support ticket note

POST/workspaces/{organizationId}/support/tickets/{ticketId}/notes

Path parameters

organizationIdstringrequired

ticketIdstringrequired

Request body

application/json

bodystringrequired

userIdstring

actorTypestring

Allowed:customeruseragentautomation

actorIdstring | null

subTypestring | null

metadataobject

Responses

201Note added

eventobjectrequired

Show properties

idstringrequired

ticketIdstringrequired

typestringrequired

subTypestring | nullrequired

actorTypestringrequired

actorIdstring | nullrequired

metadatastring | nullrequired

externalIdstring | nullrequired

createdAtstringrequired

messageobject

Show properties

idstringrequired

eventIdstringrequired

directionstringrequired

Allowed:inboundoutbound

textContentstringrequired

markdownContentstring | nullrequired

channelstringrequired

Allowed:emailslackmsteamsdiscordchatcaptureapiintercomzendeskplainlinear

customerIdstring | nullrequired

userIdstring | nullrequired

noteobject

Show properties

idstringrequired

eventIdstringrequired

bodystringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*ticketIdpath*

Bodyapplication/json

Request body

Request

curl -X POST "/workspaces/string/support/tickets/string/notes" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string",
  "userId": "string",
  "actorType": "customer",
  "actorId": "string",
  "subType": "string",
  "metadata": {
    "property1": null,
    "property2": null
  }
}'

const response = await fetch("/workspaces/string/support/tickets/string/notes", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"body\": \"string\",\n  \"userId\": \"string\",\n  \"actorType\": \"customer\",\n  \"actorId\": \"string\",\n  \"subType\": \"string\",\n  \"metadata\": {\n    \"property1\": null,\n    \"property2\": null\n  }\n}"
});

import requests

response = requests.post(
    "/workspaces/string/support/tickets/string/notes",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"body\": \"string\",\n  \"userId\": \"string\",\n  \"actorType\": \"customer\",\n  \"actorId\": \"string\",\n  \"subType\": \"string\",\n  \"metadata\": {\n    \"property1\": null,\n    \"property2\": null\n  }\n}",
)

Response

{
  "event": {
    "id": "string",
    "ticketId": "string",
    "type": "string",
    "subType": "string",
    "actorType": "string",
    "actorId": "string",
    "metadata": "string",
    "externalId": "string",
    "createdAt": "string",
    "message": {
      "id": "string",
      "eventId": "string",
      "direction": "inbound",
      "textContent": "string",
      "markdownContent": "string",
      "channel": "email",
      "customerId": "string",
      "userId": "string"
    },
    "note": {
      "id": "string",
      "eventId": "string",
      "body": "string"
    }
  }
}