Create support channel

POST/workspaces/{organizationId}/support-channels

Path parameters

organizationIdstringrequired

Request body

application/json

typestringrequired

Allowed:emailslackmsteamsdiscordchatcaptureapiintercomzendeskplain

namestringrequired

min length 1 · max length 200

configobject

isActiveboolean

default: true

Responses

201Support channel created

One of:

object

typestringrequired

Allowed:email

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

emailAddressstring

colorstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:slack

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

channelIdstring

webhookUrlstring

colorstring

botTokenstring

ingestionModestring

Allowed:manualone_to_onetime_basedai

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:msteams

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

channelIdstring

webhookUrlstring

colorstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:discord

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

channelIdstring

webhookUrlstring

colorstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:chat

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

widgetIdstring

colorstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:capture

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

formIdstring

colorstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:api

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

endpointstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:intercom

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

appIdstring

accessTokenstring

adminIdstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:zendesk

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

subdomainstring

accessTokenstring

emailstring

createdAtstringrequired

updatedAtstringrequired

object

typestringrequired

Allowed:plain

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

configobjectrequired

Show properties

workspaceIdstring

accessTokenstring

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST "/workspaces/string/support-channels" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "email",
  "name": "string",
  "config": {
    "property1": "string",
    "property2": "string"
  },
  "isActive": true
}'

const response = await fetch("/workspaces/string/support-channels", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"type\": \"email\",\n  \"name\": \"string\",\n  \"config\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  },\n  \"isActive\": true\n}"
});

import requests

response = requests.post(
    "/workspaces/string/support-channels",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"type\": \"email\",\n  \"name\": \"string\",\n  \"config\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  },\n  \"isActive\": true\n}",
)

Response

{
  "type": "email",
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "isActive": true,
  "config": {
    "emailAddress": "string",
    "color": "string"
  },
  "createdAt": "string",
  "updatedAt": "string"
}