Send an outbound support message

POST/workspaces/{organizationId}/support/channels/{channelId}/send

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

organizationIdstringrequired

channelIdstringrequired

Request body

application/json

ticketIdstringrequired

textContentstringrequired

markdownContentstring

subjectstring

idempotencyKeystring

Responses

200

Message sent

okbooleanrequired

messageIdstringrequired

sentbooleanrequired

400

Bad request

404

Ticket, customer, or channel not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*channelIdpath*

Bodyapplication/json

ticketIdstring*textContentstring*markdownContentstringsubjectstringidempotencyKeystring

Request

curl -X POST 'https://pile.nyc/workspaces/string/support/channels/string/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "ticketId": "string",
  "textContent": "string",
  "markdownContent": "string",
  "subject": "string",
  "idempotencyKey": "string"
}'

const response = await fetch("https://pile.nyc/workspaces/string/support/channels/string/send", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"ticketId\": \"string\",\n  \"textContent\": \"string\",\n  \"markdownContent\": \"string\",\n  \"subject\": \"string\",\n  \"idempotencyKey\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/support/channels/string/send",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"ticketId\": \"string\",\n  \"textContent\": \"string\",\n  \"markdownContent\": \"string\",\n  \"subject\": \"string\",\n  \"idempotencyKey\": \"string\"\n}",
)

Response

{
  "ok": true,
  "messageId": "string",
  "sent": true
}