Channels API

A community channel is the chat in one of an account’s Chat experiences. A support channel is a conversation between an account and one customer. Use the Channels API to create and list channels, and to retrieve one by its own ID or its Chat experience’s ID. You can also accept or decline direct-message requests, mark a channel read, and resolve or reopen support conversations.

Endpoints

Endpoint	Request
List Channels	GET `/channels`
Retrieve Channel	GET `/channels/{id}`
Create Channel	POST `/channels`
Accept DM Request	POST `/channels/{id}/accept`
Decline DM Request	POST `/channels/{id}/hide`
Mark Channel Read	POST `/channels/{id}/mark_read`
Mark Channel Unread	POST `/channels/{id}/mark_unread`
Pin Channel	POST `/channels/{id}/pin`
Reopen Support Channel	POST `/channels/{id}/reopen`
Resolve Support Channel	POST `/channels/{id}/resolve`
Unpin Channel	POST `/channels/{id}/unpin`
Update Channel	PATCH `/channels/{id}`
Delete Channel	DELETE `/channels/{id}`

Attributes

string

required

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

string | null

required

string

required

Creation time as an ISO 8601 timestamp.

string | null

required

When the channel was deleted or removed from your channel list, as an ISO 8601 timestamp. Null for a live channel.

string | null

required

object | null

required

The channel icon. Community channels show the experience logo, falling back to the app icon. Support channels show the account logo. Group private channels show their own icon. Null for one-to-one private channels or when no image is set.

Properties

string

required

The file’s ID, prefixed file_.

string | null

required

BlurHash placeholder for an image or video. Null when unavailable or removed by moderation.

string | null

required

The original file’s MIME type, for example application/pdf. It is kept when moderation removes the file.

string

required

When the file was created, as an ISO 8601 timestamp.

number | null

required

Audio or video duration in seconds. Null when unavailable or removed by moderation.

string | null

required

The original filename, including its extension.

integer | null

required

Image or video height in pixels. Null when unavailable or removed by moderation.

integer | null

The byte size each part (except the last) must be. Present only on create, and only for multipart uploads.

string | null

The ID of the multipart upload, passed back to complete. Present only on create, and only for multipart uploads.

object[] | null

The presigned URL for each part. Present only on create, and only for multipart uploads.

Properties

integer

required

The 1-based index of this part within the multipart upload.

string

required

The presigned URL to PUT this part’s bytes to.

string

required

The type of this object, always file.

boolean

required

Whether moderation removed the file. When true, url serves a replacement image. filename, size and content_type still describe the original file.

integer | null

required

The file size in bytes. null until the upload has finished.

object

Headers to send with the upload PUT. Present only on create.

string

required

Where the file is in its upload lifecycle.Available options: pending, processing, ready, failed

string | null

Presigned URL to PUT the file’s bytes to. Present only on create, and only for single-part uploads.

string | null

required

A URL to download the file. Public files get a permanent CDN URL, and private files get a signed URL that expires. null until the upload has finished. When moderation removes the file, a replacement image URL.

string

required

public files are served from an unsigned CDN URL. private files are served from a signed URL that expires.Available options: public, private

string | null

required

Audio waveform URL. Null when unavailable or removed by moderation.

integer | null

required

Image or video width in pixels. Null when unavailable or removed by moderation.

string

required

Available options: private, community, support

string | null

required

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

string | null

required

object | null

required

Properties

string | null

required

Stored membership ID, or null for access-derived users.

string

required

string | null

required

When the stored channel membership was created, as an ISO 8601 timestamp. Null for users whose access does not have a stored membership.

string | null

required

Your inbox state for a private channel. null for other users and other channel kinds.Available options: requested, accepted, hidden

string | null

required

Authorized participant read position. Community positions are visible only to the user themselves.

string | null

required

Available options: all, mentions, none

integer | null

required

boolean | null

required

Your unread state for the channel. null for other users.

string | null

required

When the stored channel membership last changed, as an ISO 8601 timestamp. Null for users whose access does not have a stored membership.

object

required

Properties

string

required

User ID, prefixed user_.

string | null

required

Display name.

object

required

Avatar wrapper. Its url is always present, and is a generated placeholder when the user set no picture.

Properties

string

required

Avatar image URL. Always present. It is a generated placeholder when the user set no picture.

string

required

Public username.

string

required

User ID

object | null

required

Properties

boolean

required

Prevent members from posting media.

boolean

required

Prevent members from posting links.

string[] | null

required

Words blocked in the channel. null when you cannot view this setting; an empty list means no words are blocked.

integer | null

required

Seconds a member must wait between messages. 0 or null turns the cooldown off.

string

required

Who can post messages.Available options: everyone, admins

string

required

Who can react to messages.Available options: everyone, no_one

string | null

required

boolean

required

Whether app notifications are on. Webhooks fire either way.

object | null

required

Properties

boolean

required

string

required

string | null

required

Available options: customer, support

string | null

required

When the support conversation was resolved, as an ISO 8601 timestamp. Null while unresolved.

string

required

Available options: unresolved, resolved

string

required

Last channel change as an ISO 8601 timestamp.

Channel

{
	"id": "feed_xxxxxxxxxxxxxxxxxxxxxx",
	"kind": "community",
	"name": "Detailing Talk",
	"icon": {
		"id": "file_xxxxxxxxxxxxxx",
		"object": "file",
		"filename": "detailing-talk.png",
		"content_type": "image/png",
		"size": 48213,
		"url": "https://img.whop.com/uploads/detailing-talk.png",
		"removed_by_moderation": false,
		"upload_status": "ready",
		"visibility": "public",
		"created_at": "2026-09-02T16:20:11.000Z",
		"width": 512,
		"height": 512,
		"blurhash": "LEHV6nWB2yk8pyo0adR*.7kCMdnj",
		"duration_seconds": null,
		"waveform_url": null
	},
	"notifications_enabled": true,
	"account_id": "biz_xxxxxxxxxxxxxx",
	"experience_id": "exp_xxxxxxxxxxxxxx",
	"created_at": "2026-09-02T16:20:11.000Z",
	"updated_at": "2026-10-14T09:12:40.000Z",
	"deleted_at": null,
	"last_message_id": "post_xxxxxxxxxxxxxxxxxxxxxx",
	"last_message_at": "2026-10-14T09:12:40.000Z",
	"membership": null,
	"support": null,
	"moderation": {
		"ban_media": false,
		"ban_urls": true,
		"banned_words": ["giveaway", "crypto"],
		"who_can_post": "everyone",
		"who_can_react": "everyone",
		"user_posts_cooldown_seconds": 30
	}
}

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Endpoints

Attributes

​Endpoints

​Attributes

Endpoints

Attributes