Overview
/
Developer Tools
/
API Reference
/
Users
/
Get email marketing consent state for the authenticated user.

Get email marketing consent state for the authenticated user

No path, query string, header, or cookie parameters

Response

  • 200 OK
    • //
      • confirmed_at:

        stringISO-8601,
        //
      • is_subscribed:

        boolean,
        //
      • prompt_seen_at:

        stringISO-8601,
        //
      • requested_at:

        stringISO-8601,
        //
      • should_show_prompt:

        boolean,
        //
      • status:

        "unknown"+5
        • //No choice has been made yet.
          "unknown"
        • //User has seen and dismissed the modal without deciding.
          "dismissed"
        • //User requested opt-in and must confirm via email.
          "pending"
        • //User explicitly confirmed via email flow.
          "confirmed"
        • //Recipient later unsubscribed through an email unsubscribe flow.
          "unsubscribed"
        • //User explicitly declined.
          "declined"
        //
      }

Examples

get
/user/email-marketing-consent
200 OK
Response