Knock.Channels (Knock v0.4.14) View Source
Knock resources for accessing channels
Link to this section Summary
Functions
Bulk updates channel's messages with provided action. Supports filtering messages to be updated with the following options
Link to this section Functions
Link to this function
bulk_set_messages_status(client, channel_id, action, filtering_options \\ %{})
View SourceSpecs
bulk_set_messages_status(Knock.Client.t(), String.t(), String.t(), map()) :: Knock.Api.response()
Bulk updates channel's messages with provided action. Supports filtering messages to be updated with the following options:
- tenants: Scope messages to the list of tenant ids
- has_tenant: Scope to where either do or do not have a tenant present
- recipient_ids: Scope messages to the list of recipient ids
- engagement_status: Scope messages by engagements status: read, unread, seen, unseen, archived, unarchived, interacted, link_clicked
- archived: scopes to a particular type of archival status, one of exclude, include, only
- delivery_status: scope to only messages by delivery status, these can be the following: queued, sent, undelivered, delivery_attempted, delivered
- older_than: scope to only messages that were created before provided date
- newer_than: scope to only messages that were created after provided date