Receive a generic incoming support message

POST/support/incoming/{channelId}

Path parameters

channelIdstringrequired

Request body

application/json

fromEmailstring<email>required

fromNamestring

subjectstring

default: ""

textstringrequired

htmlstring

externalTicketIdstring

externalMessageIdstring

subTypestring

createdAtstring<date-time>

Responses

201Message processed

okbooleanrequired

ticketIdstringrequired

ticketNumbernumberrequired

404Channel not found or inactive

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

channelIdpath*

Bodyapplication/json

fromEmailstring*fromNamestringsubjectstringtextstring*htmlstringexternalTicketIdstringexternalMessageIdstringsubTypestringcreatedAtstring

Request

curl -X POST "/support/incoming/string" \
  -H "Content-Type: application/json" \
  -d '{
  "fromEmail": "user@example.com",
  "fromName": "string",
  "subject": "",
  "text": "string",
  "html": "string",
  "externalTicketId": "string",
  "externalMessageId": "string",
  "subType": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}'

const response = await fetch("/support/incoming/string", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"fromEmail\": \"user@example.com\",\n  \"fromName\": \"string\",\n  \"subject\": \"\",\n  \"text\": \"string\",\n  \"html\": \"string\",\n  \"externalTicketId\": \"string\",\n  \"externalMessageId\": \"string\",\n  \"subType\": \"string\",\n  \"createdAt\": \"2019-08-24T14:15:22Z\"\n}"
});

import requests

response = requests.post(
    "/support/incoming/string",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"fromEmail\": \"user@example.com\",\n  \"fromName\": \"string\",\n  \"subject\": \"\",\n  \"text\": \"string\",\n  \"html\": \"string\",\n  \"externalTicketId\": \"string\",\n  \"externalMessageId\": \"string\",\n  \"subType\": \"string\",\n  \"createdAt\": \"2019-08-24T14:15:22Z\"\n}",
)

Response

{
  "ok": true,
  "ticketId": "string",
  "ticketNumber": 0
}