GuidesReferenceChangelogVideosDiscord
Sign UpLogin

Opt Out Search

The Opt Out Search Data Operation indicates if an end user has have opted out of a particular Conversation.

📘

Enterprise Feature

This Data Operation requires an ENTERPRISE license. If you would like to enable this feature for your Airkit Organization, please contact your Airkit representative or contact [email protected].

Use Cases

  • Check if a user has opted out of receiving messages before attempting to send them another message.
  • Confirm that a user has opted out of receiving messages before closing the Conversation.

Data Operation Properties

Identifier

Expects type Text.

The address of the external Chat source. If the Conversation will take place via a Chat Web Control, the Customer Destination will be the corresponding Session ID. If the Conversation will take place via SMS, the Customer Destination will be the corresponding phone number.

Run Results

By default, Airkit stores the output of this Data Operation in an auto-created variable called optOut that can then be passed into subsequent operations. This variable will contain information on whether the user opted out of messages via the connection specified by the Identifier.