All Implemented Interfaces:

app.knock.api.core.Params
```
public final class BulkUpdateMessageStatusParams
 implements Params
                    
```
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).

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BulkUpdateMessageStatusParams.Builder`	A builder for BulkUpdateMessageStatusParams.
`public final class`	`BulkUpdateMessageStatusParams.Body`	Updates message statuses in a specified channel. Use the `channel_id` parameter to target the channel and the `status` parameter to define what the status should be changed to (e.g. `archive`, `unarchive`). Apply to all messages or use filters to target a subset. For in-app channels, messages can be updated indefinitely via this operation. For all other channel types, messages outside the account's retention window will not be updated as part of this operation.
`public final class`	`BulkUpdateMessageStatusParams.Archived`	Limits the results to messages with the given archived status.
`public final class`	`BulkUpdateMessageStatusParams.DeliveryStatus`	Limits the results to messages with the given delivery status.
`public final class`	`BulkUpdateMessageStatusParams.EngagementStatus`	Limits the results to messages with the given engagement status.
`public final class`	`BulkUpdateMessageStatusParams.Action`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<String>`	`channelId()`
`final Optional<BulkUpdateMessageStatusParams.Action>`	`action()`
`final Optional<BulkUpdateMessageStatusParams.Archived>`	`archived()`	Limits the results to messages with the given archived status.
`final Optional<BulkUpdateMessageStatusParams.DeliveryStatus>`	`deliveryStatus()`	Limits the results to messages with the given delivery status.
`final Optional<BulkUpdateMessageStatusParams.EngagementStatus>`	`engagementStatus()`	Limits the results to messages with the given engagement status.
`final Optional<Boolean>`	`hasTenant()`	Limits the results to messages that have a tenant or not.
`final Optional<OffsetDateTime>`	`newerThan()`	Limits the results to messages inserted after the given date.
`final Optional<OffsetDateTime>`	`olderThan()`	Limits the results to messages inserted before the given date.
`final Optional<List<String>>`	`recipientIds()`	Limits the results to messages with the given recipient IDs.
`final Optional<List<String>>`	`tenants()`	Limits the results to messages with the given tenant IDs.
`final Optional<String>`	`triggerData()`	Limits the results to only messages that were generated with the given data.
`final Optional<List<String>>`	`workflows()`	Limits the results to messages with the given workflow keys.
`final JsonField<BulkUpdateMessageStatusParams.Archived>`	`_archived()`	Returns the raw JSON value of archived.
`final JsonField<BulkUpdateMessageStatusParams.DeliveryStatus>`	`_deliveryStatus()`	Returns the raw JSON value of deliveryStatus.
`final JsonField<BulkUpdateMessageStatusParams.EngagementStatus>`	`_engagementStatus()`	Returns the raw JSON value of engagementStatus.
`final JsonField<Boolean>`	`_hasTenant()`	Returns the raw JSON value of hasTenant.
`final JsonField<OffsetDateTime>`	`_newerThan()`	Returns the raw JSON value of newerThan.
`final JsonField<OffsetDateTime>`	`_olderThan()`	Returns the raw JSON value of olderThan.
`final JsonField<List<String>>`	`_recipientIds()`	Returns the raw JSON value of recipientIds.
`final JsonField<List<String>>`	`_tenants()`	Returns the raw JSON value of tenants.
`final JsonField<String>`	`_triggerData()`	Returns the raw JSON value of triggerData.
`final JsonField<List<String>>`	`_workflows()`	Returns the raw JSON value of workflows.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final BulkUpdateMessageStatusParams.Builder`	`toBuilder()`
`final BulkUpdateMessageStatusParams.Body`	`_body()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static BulkUpdateMessageStatusParams`	`none()`
`final static BulkUpdateMessageStatusParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of BulkUpdateMessageStatusParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - channelId
```
 final Optional<String> channelId()
```
  - action
```
 final Optional<BulkUpdateMessageStatusParams.Action> action()
```
  - archived
```
 final Optional<BulkUpdateMessageStatusParams.Archived> archived()
```
    Limits the results to messages with the given archived status.
  - deliveryStatus
```
 final Optional<BulkUpdateMessageStatusParams.DeliveryStatus> deliveryStatus()
```
    Limits the results to messages with the given delivery status.
  - engagementStatus
```
 final Optional<BulkUpdateMessageStatusParams.EngagementStatus> engagementStatus()
```
    Limits the results to messages with the given engagement status.
  - hasTenant
```
 final Optional<Boolean> hasTenant()
```
    Limits the results to messages that have a tenant or not.
  - newerThan
```
 final Optional<OffsetDateTime> newerThan()
```
    Limits the results to messages inserted after the given date.
  - olderThan
```
 final Optional<OffsetDateTime> olderThan()
```
    Limits the results to messages inserted before the given date.
  - recipientIds
```
 final Optional<List<String>> recipientIds()
```
    Limits the results to messages with the given recipient IDs.
  - tenants
```
 final Optional<List<String>> tenants()
```
    Limits the results to messages with the given tenant IDs.
  - triggerData
```
 final Optional<String> triggerData()
```
    Limits the results to only messages that were generated with the given data. See /api-reference/overview/trigger-data-filtering for more information.
  - workflows
```
 final Optional<List<String>> workflows()
```
    Limits the results to messages with the given workflow keys.
  - _archived
```
 final JsonField<BulkUpdateMessageStatusParams.Archived> _archived()
```
    Returns the raw JSON value of archived.
    Unlike archived, this method doesn't throw if the JSON field has an unexpected type.
  - _deliveryStatus
```
 final JsonField<BulkUpdateMessageStatusParams.DeliveryStatus> _deliveryStatus()
```
    Returns the raw JSON value of deliveryStatus.
    Unlike deliveryStatus, this method doesn't throw if the JSON field has an unexpected type.
  - _engagementStatus
```
 final JsonField<BulkUpdateMessageStatusParams.EngagementStatus> _engagementStatus()
```
    Returns the raw JSON value of engagementStatus.
    Unlike engagementStatus, this method doesn't throw if the JSON field has an unexpected type.
  - _hasTenant
```
 final JsonField<Boolean> _hasTenant()
```
    Returns the raw JSON value of hasTenant.
    Unlike hasTenant, this method doesn't throw if the JSON field has an unexpected type.
  - _newerThan
```
 final JsonField<OffsetDateTime> _newerThan()
```
    Returns the raw JSON value of newerThan.
    Unlike newerThan, this method doesn't throw if the JSON field has an unexpected type.
  - _olderThan
```
 final JsonField<OffsetDateTime> _olderThan()
```
    Returns the raw JSON value of olderThan.
    Unlike olderThan, this method doesn't throw if the JSON field has an unexpected type.
  - _recipientIds
```
 final JsonField<List<String>> _recipientIds()
```
    Returns the raw JSON value of recipientIds.
    Unlike recipientIds, this method doesn't throw if the JSON field has an unexpected type.
  - _tenants
```
 final JsonField<List<String>> _tenants()
```
    Returns the raw JSON value of tenants.
    Unlike tenants, this method doesn't throw if the JSON field has an unexpected type.
  - _triggerData
```
 final JsonField<String> _triggerData()
```
    Returns the raw JSON value of triggerData.
    Unlike triggerData, this method doesn't throw if the JSON field has an unexpected type.
  - _workflows
```
 final JsonField<List<String>> _workflows()
```
    Returns the raw JSON value of workflows.
    Unlike workflows, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final BulkUpdateMessageStatusParams.Builder toBuilder()
```
  - _body
```
 final BulkUpdateMessageStatusParams.Body _body()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static BulkUpdateMessageStatusParams none()
```
  - builder
```
 final static BulkUpdateMessageStatusParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of BulkUpdateMessageStatusParams.

Class BulkUpdateMessageStatusParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

channelId

action

archived

deliveryStatus

engagementStatus

hasTenant

newerThan

olderThan

recipientIds

tenants

triggerData

workflows

_archived

_deliveryStatus

_engagementStatus

_hasTenant

_newerThan

_olderThan

_recipientIds

_tenants

_triggerData

_workflows

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

none

builder