/

Docs
History
Schema
Generate

Filter operations

post/event/Trigger an Event
get/v1/tenant/{tenant_id}/Get Tenant
post/v1/tenant/{tenant_id}/Create / Update Tenants
delete/v1/tenant/{tenant_id}/Delete Tenant
patch/v1/tenant/{tenant_id}/properties/Update Tenant Properties
get/v1/tenant/List Tenants
post/v1/subscriber_list/{list_id}/subscriber/remove/Remove Subscribers from List
get/v1/subscriber_list/Get all Lists
post/v1/subscriber_list/Create a List
post/v1/subscriber_list/~/dry_run/Dry-run a segment query (sample rows)
post/v1/subscriber_list/~/dry_run/count/Dry-run a segment query (count only)
post/{workspace_key}/trigger/Dynamic Workflow Trigger
get/v1/user/{distinct_id}/preference/category/All Categories
post/v1/subscriber_list/{list_id}/subscriber/add/Add Users to List
get/v1/subscriber_list/{list_id}/Get List configuration
post/{workspace_key}/broadcast/Trigger Broadcast
get/v1/user/{distinct_id}/preference/channel_preference/All Channels
patch/v1/user/{distinct_id}/preference/channel_preference/Overall Channel level
get/v1/user/{distinct_id}/preference/category/{category_slug}/Single Category
patch/v1/user/{distinct_id}/preference/category/{category_slug}/Category and Channel within Category
patch/v1/subscriber_list/{list_id}/delete/Delete List
get/v1/tenant/{tenant_id}/preference/Get Tenant Full Preference
get/v1/tenant/{tenant_id}/preference/category/Get Tenant Preference All Categories
get/v1/tenant/{tenant_id}/preference/category/{category}/Get Tenant Preference Single Category
patch/v1/tenant/{tenant_id}/preference/category/{category}/Update Tenant Preference Single Category
get/v1/tenant/{tenant_id}/category/Get Tenant Default Preference
post/v1/subscriber_list/{list_id}/version/{version_id}/subscriber/add/Add Users to Draft List
patch/v1/subscriber_list/{list_id}/version/{version_id}/delete/Delete Draft List
get/v1/template/{template_slug}/Fetch Template details
patch/v1/subscriber_list/{list_id}/version/{version_id}/finish_sync/Finish Sync
post/v1/subscriber_list/{list_id}/version/{version_id}/subscriber/remove/Remove Subscribers from Draft List
post/v1/subscriber_list/{list_id}/start_sync/Start Sync
get/v1/template/{template_slug}/channel/{channel_slug}/Fetch Template content for a channel
get/v1/template/Fetch Template List
post/trigger/Trigger Workflow (single or bulk)
post/trigger/list/Trigger Workflow on a List
post/v1/workflow_run/cancel/Cancel Workflow
post/v1/broadcast_run/cancel/Cancel Broadcast
patch/v1/bulk/user/preference/Bulk Update
patch/v1/bulk/user/preference/reset/Reset
get/v1/user/{distinct_id}/preference/Full Preference
patch/v1/user/{distinct_id}/preference/Update User Full Preference
get/v1/subscriber_list/{list_id}/subscriber/Get list subscribers
get/v1/object/{object_type}/{id}/Fetch Object by id
post/v1/object/{object_type}/{id}/Create / Update Objects
delete/v1/object/{object_type}/{id}/Delete an Object
patch/v1/object/{object_type}/{id}/Edit Object Profile
get/v1/object/{object_type}/{id}/subscription/List Object Subscriptions
post/v1/object/{object_type}/{id}/subscription/Add Subscription
delete/v1/object/{object_type}/{id}/subscription/Remove Object Subscriptions
get/v1/object/{object_type}/List Objects by type
get/v1/object/{object_type}/{id}/preference/category/{category_slug}/Single Category
patch/v1/object/{object_type}/{id}/preference/category/{category_slug}/Category and Channel within Category
get/v1/object/{object_type}/{id}/preference/channel_preference/All Channels
patch/v1/object/{object_type}/{id}/preference/channel_preference/Overall Channel level
get/v1/object/{object_type}/{id}/preference/Full Preference
patch/v1/object/{object_type}/{id}/preference/Update Object Full Preference
get/v1/object/{object_type}/{id}/preference/category/All Categories
get/v1/user/{distinct_id}/Fetch User by id
post/v1/user/{distinct_id}/Create / Update Users
delete/v1/user/{distinct_id}/Delete user
patch/v1/user/{distinct_id}/Edit User Profile
get/v1/user/List Users
post/v1/user/{distinct_id}/merge/Merge User Profiles
get/v1/user/{distinct_id}/subscribed_to/object/Fetch User object subscriptions
get/v1/user/{distinct_id}/subscribed_to/list/Fetch User list subscriptions
get/v1/user/{distinct_id}/tenant/{tenant_id}/Fetch User Tenant Profile
post/v1/user/{distinct_id}/tenant/{tenant_id}/Upsert User Tenant Profile
delete/v1/user/{distinct_id}/tenant/{tenant_id}/Delete User Tenant Mapping
get/v1/user/{distinct_id}/tenant/List User Tenant Profiles
get/v1/object/{object_type}/{id}/subscribed_to/object/Fetch Object subscriptions
get/v1/message/List Messages
get/v1/message/{message_id}/content/Get Message Content
patch/v1/bulk/message/Bulk Update Message Status
get/v1/workspace/List Workspaces
post/v1/workspace/Create Workspace
get/v1/workspace/{workspace_slug}/config/Get Workspace Config
patch/v1/workspace/{workspace_slug}/config/Update Workspace Config
get/v1/{workspace}/ws_api_key/List Workspace API Keys
post/v1/{workspace}/ws_api_key/Create Workspace API Key
delete/v1/{workspace}/ws_api_key/{api_key_id}/Delete API Key
get/v1/{workspace}/ws_key/List Workspace Keys
post/v1/{workspace}/ws_key/Create Workspace Key
get/v1/{workspace}/ws_key/{workspace_key_id}/Get Workspace Key
delete/v1/{workspace}/ws_key/{workspace_key_id}/Delete Workspace Key
patch/v1/{workspace}/ws_key/{workspace_key_id}/rotate/Rotate Workspace Key Secret
get/v1/{workspace}/ws_public_key/List Workspace Public Keys
post/v1/{workspace}/ws_public_key/Create Workspace Public Key
delete/v1/{workspace}/ws_public_key/{public_key_id}/Delete Workspace Public Key
patch/v1/{workspace}/ws_public_key/{public_key_id}/Enable/Disable Secure Mode on Public Key
patch/v1/{workspace}/ws_public_key/{public_key_id}/rotate/Rotate Workspace Public Key
get/v1/{workspace}/ws_signing_key/List Workspace Signing Keys
post/v1/{workspace}/ws_signing_key/Create Workspace Signing Key
delete/v1/{workspace}/ws_signing_key/{signing_key_uid}/Delete Workspace Signing Key
post/v1/{workspace}/ws_signing_key/{signing_key_uid}/roll/Roll Workspace Signing Key
get/v1/{workspace}/workflow/List Workflows
get/v1/{workspace}/workflow/{slug}/Get Workflow Details
post/v1/{workspace}/workflow/{slug}/Create or Update Workflow
delete/v1/{workspace}/workflow/{slug}/Delete Workflow
patch/v1/{workspace}/workflow/{slug}/commit/Commit Workflow
patch/v1/{workspace}/workflow/{slug}/enable/Enable/Disable Workflow

Changes to Fetch Template details

get/v1/template/{template_slug}/

Jul 13, 2026e54dd32705e8 Revision changes
- breaking
  api path removed without deprecation
- info
  endpoint added