Create support ticket note

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

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

ticketIdstringrequired

Request body

application/json

bodystringrequired

userIdstring

actorTypestring

Allowed:customeruseragentautomation

actorIdstring | null

subTypestring | null

metadataobject

Responses

201

Note 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:emailslackmsteamsdiscordchatcaptureapiintercomzendeskplainlinearsms

customerIdstring | nullrequired

userIdstring | nullrequired

noteobject

Show properties

idstringrequired

eventIdstringrequired

bodystringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*ticketIdpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://pile.nyc/workspaces/string/support/tickets/string/notes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -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("https://pile.nyc/workspaces/string/support/tickets/string/notes", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "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(
    "https://pile.nyc/workspaces/string/support/tickets/string/notes",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "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"
    }
  }
}