******
Opt-in
******

Opt-in indicates which newsletters, marketing emails and other email services are available.
A consumer can choose which opt-ins to enable when :doc:`creating a new order </documentation/orders>` or :doc:`when personalizing a ticket </documentation/personalization>`.


Retrieving and displaying opt-in settings from an Event
=======================================================

An object describing the opt-in configuration for an :doc:`/documentation/event`.
An event may offer two opt-in channels, ``opt_in`` and ``opt_in_2``.

=============== ============================== ==============================
Field name      Type                           Description
=============== ============================== ==============================
default         Boolean                        Opt-in checkbox default value.
text            :doc:`i18n` object             Optional opt-in description.
=============== ============================== ==============================


.. TODO
    Document Sale and Channel opt-ins because they are structured differently.


.. _set-opt-in:

Setting a consumer's opt-in preferences
=======================================

.. code-block:: javascript

  {
    "opt_in": {
      "opt_in": false,
      "opt_in_2": true
    }
  }