Docs
/
/
Contact supportLog inGet started
Overview
Client libraries
API keys
Authentication
Rate limits
Batch rate limits
Idempotent requests
Data retention
Bulk endpoints
Trigger data filtering
Pagination
Errors
Common error codes
Overview
Get startedLog inContact support
Platform
Integrations
In-app UI
API reference
CLI reference
Management API
Developer tools
Tutorials

Channels API reference

Complete reference documentation for the Channels resource.

Channels

#

A Channel is a delivery method for a message.

Bulk

#

Bulk operations available for messages of a given channel.

Endpoints

POST/v1/channels/{channel_id}/messages/bulk/{action}
Retention policy applied

Bulk update message statuses for channel

#

Bulk update the status of messages for a specific channel. The channel is specified by the channel_id parameter. The action to perform is specified by the action parameter, where the action is a status change action (e.g. archive, unarchive).

Endpoint

POST/v1/channels/{channel_id}/messages/bulk/{action}
Tier 2

Path parameters

channel_id
string(uuid)

The ID of the channel to update messages for.

action
enum(string)

The target status to be applied to the messages.

seenunseenreadunreadarchivedunarchivedinteractedarchiveunarchivedelete

Request body

archived
enum(string)

Limits the results to messages with the given archived status.

excludeincludeonly
delivery_status
enum(string)

Limits the results to messages with the given delivery status.

queuedsentdelivereddelivery_attemptedundeliverednot_sentbounced
engagement_status
enum(string)

Limits the results to messages with the given engagement status.

seenunseenreadunreadarchivedunarchivedlink_clickedinteracted
has_tenant
boolean

Limits the results to messages that have a tenant or not.

newer_than
string(date-time)

Limits the results to messages inserted after the given date.

older_than
string(date-time)

Limits the results to messages inserted before the given date.

recipient_ids
string[]

Limits the results to messages with the given recipient IDs.

tenants
string[]

Limits the results to messages with the given tenant IDs.

trigger_data
string

Limits the results to only messages that were generated with the given data. See trigger data filtering for more information.

workflows
string[]

Limits the results to messages with the given workflow keys.

Returns

BulkOperation

A bulk operation entity.

__typename
string

The typename of the schema.

completed_at
string(date-time)

Timestamp when the bulk operation was completed.

error_count
integer

The number of failed operations.

error_items
object[]

A list of items that failed to be processed.

collection
string

The collection this object belongs to.

id
string
Required

Unique identifier for the object.

estimated_total_rows
integer

The estimated total number of rows to process.

failed_at
string(date-time)

Timestamp when the bulk operation failed.

id
string(uuid)

Unique identifier for the bulk operation.

inserted_at
string(date-time)

Timestamp when the resource was created.

name
string

The name of the bulk operation.

processed_rows
integer

The number of rows processed so far.

progress_path
string(uri)

The URI to the bulk operation's progress.

started_at
string(date-time)

Timestamp when the bulk operation was started.

status
enum(string)

The status of the bulk operation.

queuedprocessingcompletedfailed
success_count
integer

The number of successful operations.

updated_at
string(date-time)

The timestamp when the resource was last updated.

New chat