Create Channel

curl --request POST \
  --url https://api.whop.com/api/v1/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "private",
  "account_id": "biz_xxxxxxxxxxxxxx",
  "customer_user_id": "<string>",
  "name": "<string>",
  "notifications_enabled": true,
  "participant_user_ids": [
    "user_xxxxxxxxxxxxxx"
  ],
  "product_id": "<string>",
  "sender_user_id": "<string>"
}
'

import requests

url = "https://api.whop.com/api/v1/channels"

payload = {
    "kind": "private",
    "account_id": "biz_xxxxxxxxxxxxxx",
    "customer_user_id": "<string>",
    "name": "<string>",
    "notifications_enabled": True,
    "participant_user_ids": ["user_xxxxxxxxxxxxxx"],
    "product_id": "<string>",
    "sender_user_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    kind: 'private',
    account_id: 'biz_xxxxxxxxxxxxxx',
    customer_user_id: '<string>',
    name: '<string>',
    notifications_enabled: true,
    participant_user_ids: ['user_xxxxxxxxxxxxxx'],
    product_id: '<string>',
    sender_user_id: '<string>'
  })
};

fetch('https://api.whop.com/api/v1/channels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/channels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'kind' => 'private',
    'account_id' => 'biz_xxxxxxxxxxxxxx',
    'customer_user_id' => '<string>',
    'name' => '<string>',
    'notifications_enabled' => true,
    'participant_user_ids' => [
        'user_xxxxxxxxxxxxxx'
    ],
    'product_id' => '<string>',
    'sender_user_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/channels"

	payload := strings.NewReader("{\n  \"kind\": \"private\",\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"customer_user_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"notifications_enabled\": true,\n  \"participant_user_ids\": [\n    \"user_xxxxxxxxxxxxxx\"\n  ],\n  \"product_id\": \"<string>\",\n  \"sender_user_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/channels")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kind\": \"private\",\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"customer_user_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"notifications_enabled\": true,\n  \"participant_user_ids\": [\n    \"user_xxxxxxxxxxxxxx\"\n  ],\n  \"product_id\": \"<string>\",\n  \"sender_user_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/channels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"kind\": \"private\",\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"customer_user_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"notifications_enabled\": true,\n  \"participant_user_ids\": [\n    \"user_xxxxxxxxxxxxxx\"\n  ],\n  \"product_id\": \"<string>\",\n  \"sender_user_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "created_at": "2026-01-01T12:00:00.000Z",
  "experience_id": null,
  "icon": {
    "blurhash": null,
    "content_type": "application/pdf",
    "created_at": "2026-01-01T12:00:00.000Z",
    "duration_seconds": null,
    "filename": "evidence.pdf",
    "height": null,
    "id": "file_xxxxxxxxxxxxxx",
    "object": "file",
    "removed_by_moderation": false,
    "size": 9670,
    "upload_status": "pending",
    "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "visibility": "private",
    "waveform_url": null,
    "width": null,
    "multipart_chunk_size": 5242880,
    "multipart_upload_id": "upload-id",
    "multipart_upload_urls": [
      {
        "part_number": 1,
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
      }
    ],
    "upload_headers": {},
    "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
  },
  "id": "feed_xxxxxxxxxxxxxxxxxxxxxx",
  "kind": "private",
  "last_message_at": "2026-01-01T12:00:00.000Z",
  "last_message_id": "post_xxxxxxxxxxxxxxxxxxxxxx",
  "membership": {
    "channel_id": "feed_xxxxxxxxxxxxxxxxxxxxxx",
    "created_at": "2026-01-01T12:00:00.000Z",
    "id": "memb_1_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "inbox_status": "accepted",
    "last_viewed_at": "2026-01-01T12:00:00.000Z",
    "notification_preference": "all",
    "pinned_position": null,
    "unread": false,
    "updated_at": "2026-01-01T12:00:00.000Z",
    "user": {
      "id": "user_xxxxxxxxxxxxxx",
      "name": "Dana Whitfield",
      "profile_picture": {
        "url": "https://ui-avatars.com/api/"
      },
      "username": "danawhitfield"
    },
    "user_id": "user_xxxxxxxxxxxxxx"
  },
  "moderation": {
    "ban_media": true,
    "ban_urls": true,
    "banned_words": [
      "<string>"
    ],
    "user_posts_cooldown_seconds": 123,
    "who_can_post": "everyone",
    "who_can_react": "everyone"
  },
  "name": "Renamed",
  "notifications_enabled": true,
  "support": {
    "awaiting_reply": false,
    "customer_user_id": "user_xxxxxxxxxxxxxx",
    "last_message_by": "customer",
    "resolved_at": "2026-01-01T12:00:00.000Z",
    "status": "resolved"
  },
  "updated_at": "2026-01-01T12:00:00.000Z"
}

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "created_at": "2026-01-01T12:00:00.000Z",
  "experience_id": null,
  "icon": {
    "blurhash": null,
    "content_type": "application/pdf",
    "created_at": "2026-01-01T12:00:00.000Z",
    "duration_seconds": null,
    "filename": "evidence.pdf",
    "height": null,
    "id": "file_xxxxxxxxxxxxxx",
    "object": "file",
    "removed_by_moderation": false,
    "size": 9670,
    "upload_status": "pending",
    "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "visibility": "private",
    "waveform_url": null,
    "width": null,
    "multipart_chunk_size": 5242880,
    "multipart_upload_id": "upload-id",
    "multipart_upload_urls": [
      {
        "part_number": 1,
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
      }
    ],
    "upload_headers": {},
    "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
  },
  "id": "feed_xxxxxxxxxxxxxxxxxxxxxx",
  "kind": "private",
  "last_message_at": "2026-01-01T12:00:00.000Z",
  "last_message_id": "post_xxxxxxxxxxxxxxxxxxxxxx",
  "membership": {
    "channel_id": "feed_xxxxxxxxxxxxxxxxxxxxxx",
    "created_at": "2026-01-01T12:00:00.000Z",
    "id": "memb_1_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "inbox_status": "accepted",
    "last_viewed_at": "2026-01-01T12:00:00.000Z",
    "notification_preference": "all",
    "pinned_position": null,
    "unread": false,
    "updated_at": "2026-01-01T12:00:00.000Z",
    "user": {
      "id": "user_xxxxxxxxxxxxxx",
      "name": "Dana Whitfield",
      "profile_picture": {
        "url": "https://ui-avatars.com/api/"
      },
      "username": "danawhitfield"
    },
    "user_id": "user_xxxxxxxxxxxxxx"
  },
  "moderation": {
    "ban_media": true,
    "ban_urls": true,
    "banned_words": [
      "<string>"
    ],
    "user_posts_cooldown_seconds": 123,
    "who_can_post": "everyone",
    "who_can_react": "everyone"
  },
  "name": "Renamed",
  "notifications_enabled": true,
  "support": {
    "awaiting_reply": false,
    "customer_user_id": "user_xxxxxxxxxxxxxx",
    "last_message_by": "customer",
    "resolved_at": "2026-01-01T12:00:00.000Z",
    "status": "resolved"
  },
  "updated_at": "2026-01-01T12:00:00.000Z"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

POST

channels

Create Channel

curl --request POST \
  --url https://api.whop.com/api/v1/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "private",
  "account_id": "biz_xxxxxxxxxxxxxx",
  "customer_user_id": "<string>",
  "name": "<string>",
  "notifications_enabled": true,
  "participant_user_ids": [
    "user_xxxxxxxxxxxxxx"
  ],
  "product_id": "<string>",
  "sender_user_id": "<string>"
}
'

import requests

url = "https://api.whop.com/api/v1/channels"

payload = {
    "kind": "private",
    "account_id": "biz_xxxxxxxxxxxxxx",
    "customer_user_id": "<string>",
    "name": "<string>",
    "notifications_enabled": True,
    "participant_user_ids": ["user_xxxxxxxxxxxxxx"],
    "product_id": "<string>",
    "sender_user_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    kind: 'private',
    account_id: 'biz_xxxxxxxxxxxxxx',
    customer_user_id: '<string>',
    name: '<string>',
    notifications_enabled: true,
    participant_user_ids: ['user_xxxxxxxxxxxxxx'],
    product_id: '<string>',
    sender_user_id: '<string>'
  })
};

fetch('https://api.whop.com/api/v1/channels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/channels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'kind' => 'private',
    'account_id' => 'biz_xxxxxxxxxxxxxx',
    'customer_user_id' => '<string>',
    'name' => '<string>',
    'notifications_enabled' => true,
    'participant_user_ids' => [
        'user_xxxxxxxxxxxxxx'
    ],
    'product_id' => '<string>',
    'sender_user_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/channels"

	payload := strings.NewReader("{\n  \"kind\": \"private\",\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"customer_user_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"notifications_enabled\": true,\n  \"participant_user_ids\": [\n    \"user_xxxxxxxxxxxxxx\"\n  ],\n  \"product_id\": \"<string>\",\n  \"sender_user_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/channels")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kind\": \"private\",\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"customer_user_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"notifications_enabled\": true,\n  \"participant_user_ids\": [\n    \"user_xxxxxxxxxxxxxx\"\n  ],\n  \"product_id\": \"<string>\",\n  \"sender_user_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/channels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"kind\": \"private\",\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"customer_user_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"notifications_enabled\": true,\n  \"participant_user_ids\": [\n    \"user_xxxxxxxxxxxxxx\"\n  ],\n  \"product_id\": \"<string>\",\n  \"sender_user_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "created_at": "2026-01-01T12:00:00.000Z",
  "experience_id": null,
  "icon": {
    "blurhash": null,
    "content_type": "application/pdf",
    "created_at": "2026-01-01T12:00:00.000Z",
    "duration_seconds": null,
    "filename": "evidence.pdf",
    "height": null,
    "id": "file_xxxxxxxxxxxxxx",
    "object": "file",
    "removed_by_moderation": false,
    "size": 9670,
    "upload_status": "pending",
    "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "visibility": "private",
    "waveform_url": null,
    "width": null,
    "multipart_chunk_size": 5242880,
    "multipart_upload_id": "upload-id",
    "multipart_upload_urls": [
      {
        "part_number": 1,
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
      }
    ],
    "upload_headers": {},
    "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
  },
  "id": "feed_xxxxxxxxxxxxxxxxxxxxxx",
  "kind": "private",
  "last_message_at": "2026-01-01T12:00:00.000Z",
  "last_message_id": "post_xxxxxxxxxxxxxxxxxxxxxx",
  "membership": {
    "channel_id": "feed_xxxxxxxxxxxxxxxxxxxxxx",
    "created_at": "2026-01-01T12:00:00.000Z",
    "id": "memb_1_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "inbox_status": "accepted",
    "last_viewed_at": "2026-01-01T12:00:00.000Z",
    "notification_preference": "all",
    "pinned_position": null,
    "unread": false,
    "updated_at": "2026-01-01T12:00:00.000Z",
    "user": {
      "id": "user_xxxxxxxxxxxxxx",
      "name": "Dana Whitfield",
      "profile_picture": {
        "url": "https://ui-avatars.com/api/"
      },
      "username": "danawhitfield"
    },
    "user_id": "user_xxxxxxxxxxxxxx"
  },
  "moderation": {
    "ban_media": true,
    "ban_urls": true,
    "banned_words": [
      "<string>"
    ],
    "user_posts_cooldown_seconds": 123,
    "who_can_post": "everyone",
    "who_can_react": "everyone"
  },
  "name": "Renamed",
  "notifications_enabled": true,
  "support": {
    "awaiting_reply": false,
    "customer_user_id": "user_xxxxxxxxxxxxxx",
    "last_message_by": "customer",
    "resolved_at": "2026-01-01T12:00:00.000Z",
    "status": "resolved"
  },
  "updated_at": "2026-01-01T12:00:00.000Z"
}

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "created_at": "2026-01-01T12:00:00.000Z",
  "experience_id": null,
  "icon": {
    "blurhash": null,
    "content_type": "application/pdf",
    "created_at": "2026-01-01T12:00:00.000Z",
    "duration_seconds": null,
    "filename": "evidence.pdf",
    "height": null,
    "id": "file_xxxxxxxxxxxxxx",
    "object": "file",
    "removed_by_moderation": false,
    "size": 9670,
    "upload_status": "pending",
    "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "visibility": "private",
    "waveform_url": null,
    "width": null,
    "multipart_chunk_size": 5242880,
    "multipart_upload_id": "upload-id",
    "multipart_upload_urls": [
      {
        "part_number": 1,
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
      }
    ],
    "upload_headers": {},
    "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
  },
  "id": "feed_xxxxxxxxxxxxxxxxxxxxxx",
  "kind": "private",
  "last_message_at": "2026-01-01T12:00:00.000Z",
  "last_message_id": "post_xxxxxxxxxxxxxxxxxxxxxx",
  "membership": {
    "channel_id": "feed_xxxxxxxxxxxxxxxxxxxxxx",
    "created_at": "2026-01-01T12:00:00.000Z",
    "id": "memb_1_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "inbox_status": "accepted",
    "last_viewed_at": "2026-01-01T12:00:00.000Z",
    "notification_preference": "all",
    "pinned_position": null,
    "unread": false,
    "updated_at": "2026-01-01T12:00:00.000Z",
    "user": {
      "id": "user_xxxxxxxxxxxxxx",
      "name": "Dana Whitfield",
      "profile_picture": {
        "url": "https://ui-avatars.com/api/"
      },
      "username": "danawhitfield"
    },
    "user_id": "user_xxxxxxxxxxxxxx"
  },
  "moderation": {
    "ban_media": true,
    "ban_urls": true,
    "banned_words": [
      "<string>"
    ],
    "user_posts_cooldown_seconds": 123,
    "who_can_post": "everyone",
    "who_can_react": "everyone"
  },
  "name": "Renamed",
  "notifications_enabled": true,
  "support": {
    "awaiting_reply": false,
    "customer_user_id": "user_xxxxxxxxxxxxxx",
    "last_message_by": "customer",
    "resolved_at": "2026-01-01T12:00:00.000Z",
    "status": "resolved"
  },
  "updated_at": "2026-01-01T12:00:00.000Z"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, an App API key, an account access token, or an account-scoped user token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Idempotency-Key

string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255

Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-11-07"

Body

application/json

kind

enum<string>

required

Channel kind. private is a one-to-one or group conversation, community creates a Chat experience on the account, and support opens a conversation between the account and a customer.

Available options:

private,

community,

support

Example:

"private"

account_id

string

Owning account ID, prefixed biz_. Accepted for all channel kinds. Required for community and support channels unless supplied by the credential's account context.

Pattern: \S

Example:

"biz_xxxxxxxxxxxxxx"

customer_user_id

string

Customer ID, prefixed user_. Support channels only; requires support management permission. Omit to open your own support conversation.

Pattern: \S

name

string

Channel display name, accepted for all channel kinds. Used only when a channel is created. For community channels, names the new Chat experience; defaults to the Chat app's name.

Maximum string length: 255

Pattern: \S

notifications_enabled

boolean

Whether app notifications are on for any channel kind. Webhooks fire either way. Defaults to true. Used only when a channel is created; change an existing channel with PATCH /channels/:id.

participant_user_ids

string[]

Other participant IDs, prefixed user_, excluding the sender. Required for private channels and accepted only for them. One ID creates a one-to-one conversation; more create a group.

Required array length: 1 - 49 elements

Pattern: \S

product_id

string

Product ID, prefixed prod_, to attach the new community channel to. Accepted only for community channels. Must belong to the owning account and requires the experience:attach permission on it. Omit to leave the channel unattached.

Pattern: \S

sender_user_id

string

Sender ID, prefixed user_. Private channels only. Required for account API keys; omit when authenticating as a user. Requires channel management permission on the account.

Pattern: \S

Response

existing channel returned

account_id

string | null

required

Example:

"biz_xxxxxxxxxxxxxx"

created_at

string

required

Creation time as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

experience_id

string | null

required

Example:

null

icon

object | null

required

Experience logo, falling back to the app icon for community channels. Null for other channel kinds or when neither image exists.

Show child attributes

string

required

Existing public channel ID, preserved across REST and chat clients.

Example:

"feed_xxxxxxxxxxxxxxxxxxxxxx"

kind

enum<string>

required

Available options:

private,

community,

support

Example:

"private"

last_message_at

string | null

required

When the channel last recorded message activity, as an ISO 8601 timestamp. Null when no message activity is recorded.

Example:

"2026-01-01T12:00:00.000Z"

last_message_id

string | null

required

Example:

"post_xxxxxxxxxxxxxxxxxxxxxx"

membership

object | null

required

Show child attributes

moderation

object | null

required

Show child attributes

name

string | null

required

Example:

"Renamed"

notifications_enabled

boolean

required

Whether app notifications are on. Webhooks fire either way.

Example:

true

support

object | null

required

Show child attributes

updated_at

string

required

Last channel change as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Create Channel

Authorizations

Headers

Body

Response