The Channels API provides operations for creating, listing, updating, pausing, restoring, deleting, purging, and configuring communication channels.
Channel operations are workspace-authenticated unless explicitly marked as public bootstrap or validation operations.
Endpoints
| Method | Path | Purpose |
| POST | /channels | Create Channel |
| POST | /channels/ensure | Ensure Channel exists |
| GET | /channels | List Channels |
| GET | /channels/all | List all Channels |
| GET | /channels/deleted | List deleted Channels |
| GET | /channels/:id | Get Channel |
| POST | /channels/init | Create Channel with settings |
| POST | /channels/:id/pause | Pause Channel |
| POST | /channels/:id/restore | Restore Channel |
| DELETE | /channels/:id | Move Channel to trash |
| DELETE | /channels/:id/purge | Permanently purge Channel |
| GET | /channels/:channelId/settings | Get Channel settings |
| POST | /channels/:channelId/settings | Create Channel settings |
| PATCH | /channels/:channelId/settings | Update Channel settings |
| DELETE | /channels/:channelId/settings | Delete Channel settings |
| GET | /api/public/channels/:channelId/settings | Get public Channel settings |
| POST | /api/public/channel-token/validate | Validate Channel token |
| POST | /api/public/shopify/validate | Validate Shopify token |
| POST | /api/public/wordpress/validate | Validate WordPress token |
Channel Types
The audit identifies:
WEB
MOBILE
WORDPRESS
SHOPIFY
Channel states include:
ACTIVE
PAUSED
TRASH
PURGED
Channel Token Security
Channel tokens are used by Channel bootstrap and validation flows.
Do not publish real Channel Tokens in examples or screenshots.
Need Help?
Email: support@ysdesk.com
Documentation: https://docs.ysplugins.com/ys-desk