Create support ticket

POST/workspaces/{organizationId}/support/tickets

Path parameters

organizationIdstringrequired

Request body

application/json

customerIdstringrequired

titlestringrequired

min length 1

sourceChannelstringrequired

Allowed:emailslackmsteamsdiscordchatcaptureapiintercomzendeskplainlinear

prioritystring

default: "medium"

Allowed:lowmediumhighurgent

statusstring

default: "todo"

Allowed:tododonesnoozed

externalIdstring

externalSourcestring

default: "manual"

Allowed:intercomzendeskplainemailslackmsteamsdiscordchatapimanual

issueIdstring

messageobject

Show properties

textContentstringrequired

markdownContentstring

channelstring

default: "chat"

Allowed:emailslackmsteamsdiscordchatcaptureapiintercomzendeskplainlinear

Responses

201Ticket created

ticketobjectrequired

Show properties

idstringrequired

organizationIdstringrequired

customerIdstringrequired

numberintegerrequired

externalIdstring | nullrequired

externalSourcestringrequired

titlestringrequired

statusstringrequired

Allowed:tododonesnoozed

prioritystringrequired

Allowed:lowmediumhighurgent

sourceChannelstringrequired

Allowed:emailslackmsteamsdiscordchatcaptureapiintercomzendeskplainlinear

issueIdstring | nullrequired

snoozedUntilstring | nullrequired

lastCustomerMessageAtstring | nullrequired

lastAgentMessageAtstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

customerobjectrequired

Show properties

idstringrequired

emailstringrequired

fullNamestring | nullrequired

phonestring | nullrequired

companiesobject[]required

Show properties

Array of object

idstringrequired

namestringrequired

isPrimarybooleanrequired

identitiesobject[]required

Show properties

Array of object

idstringrequired

typestringrequired

Allowed:emailphoneslackmsteamsdiscordwhatsappchatapisocialcustom

valuestringrequired

subTypestring | nullrequired

isPrimarybooleanrequired

labelsobject[]required

Show properties

Array of object

idstringrequired

labelIdstringrequired

namestringrequired

colorstring | nullrequired

assigneesobject[]required

Show properties

Array of object

idstringrequired

typestringrequired

Allowed:userteam

assigneeIdstringrequired

namestring | nullrequired

isPrimarybooleanrequired

eventsobject[]required

Show properties

Array of object

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*

Bodyapplication/json

Request body

Request

curl -X POST "/workspaces/string/support/tickets" \
  -H "Content-Type: application/json" \
  -d '{
  "customerId": "string",
  "title": "string",
  "sourceChannel": "email",
  "priority": "low",
  "status": "todo",
  "externalId": "string",
  "externalSource": "intercom",
  "issueId": "string",
  "message": {
    "textContent": "string",
    "markdownContent": "string",
    "channel": "email"
  }
}'

const response = await fetch("/workspaces/string/support/tickets", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"customerId\": \"string\",\n  \"title\": \"string\",\n  \"sourceChannel\": \"email\",\n  \"priority\": \"low\",\n  \"status\": \"todo\",\n  \"externalId\": \"string\",\n  \"externalSource\": \"intercom\",\n  \"issueId\": \"string\",\n  \"message\": {\n    \"textContent\": \"string\",\n    \"markdownContent\": \"string\",\n    \"channel\": \"email\"\n  }\n}"
});

import requests

response = requests.post(
    "/workspaces/string/support/tickets",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"customerId\": \"string\",\n  \"title\": \"string\",\n  \"sourceChannel\": \"email\",\n  \"priority\": \"low\",\n  \"status\": \"todo\",\n  \"externalId\": \"string\",\n  \"externalSource\": \"intercom\",\n  \"issueId\": \"string\",\n  \"message\": {\n    \"textContent\": \"string\",\n    \"markdownContent\": \"string\",\n    \"channel\": \"email\"\n  }\n}",
)

Response

{
  "ticket": {
    "id": "string",
    "organizationId": "string",
    "customerId": "string",
    "number": 0,
    "externalId": "string",
    "externalSource": "string",
    "title": "string",
    "status": "todo",
    "priority": "low",
    "sourceChannel": "email",
    "issueId": "string",
    "snoozedUntil": "string",
    "lastCustomerMessageAt": "string",
    "lastAgentMessageAt": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "customer": {
      "id": "string",
      "email": "string",
      "fullName": "string",
      "phone": "string"
    },
    "companies": [
      {
        "id": "string",
        "name": "string",
        "isPrimary": true
      }
    ],
    "identities": [
      {
        "id": "string",
        "type": "email",
        "value": "string",
        "subType": "string",
        "isPrimary": true
      }
    ],
    "labels": [
      {
        "id": "string",
        "labelId": "string",
        "name": "string",
        "color": "string"
      }
    ],
    "assignees": [
      {
        "id": "string",
        "type": "user",
        "assigneeId": "string",
        "name": "string",
        "isPrimary": true
      }
    ],
    "events": [
      {
        "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"
        }
      }
    ]
  }
}