Docs Home
/
Zoo Developer Tools
/
API
/
Users
/
Get email marketing consent state for the authenticated user.

Get email marketing consent state for the authenticated user

Parameters

No parameters

Returns

  • 200 OK

    successful operation

    Name

    Type

    Req.

    body

    object
    optional
    Object Properties
    • confirmed_at

      string / ISO-8601
      optional
    • is_subscribed

      boolean
      optional
    • prompt_seen_at

      string / ISO-8601
      optional
    • requested_at

      string / ISO-8601
      optional
    • should_show_prompt

      boolean
      optional
    • status

      string
      optional
      Possible values
      • unknown:  No choice has been made yet.
      • dismissed:  User has seen and dismissed the modal without deciding.
      • pending:  User requested opt-in and must confirm via email.
      • confirmed:  User explicitly confirmed via email flow.
      • declined:  User explicitly declined.
get
/user/email-marketing-consent
200 OK
Response
Zookeeper is here!
You guide the design. Zookeeper does the work.