Email Accounts Object REST

Skip to end of metadata
Go to start of metadata


Lite Registration and Subscription Management are premium platforms that require separate activation. For inquiries, contact your Account Manager by filling a support form. You can access the support page by clicking Support on the upper menu after logging into your Gigya Console.

Description

Email accounts are created once either Lite Registration and / or Subscriptions are enabled in your Gigya site. They use emails as the identifier to merge data from both lite and fully registered accounts. Note that data is merged from full or lite accounts into email accounts and not vice versa, with the exception of subscription data that is shared in real time between account types.

An email account is created for the first time when a user subscribes or registers to your site with a unique email address. This email address is saved in the profile.email field. 

Email accounts are updated whenever the corresponding registered account is updated, and/or whenever a new lite account is created with the same email address. 

 

Data Members

FieldTypeDescription
createdstringThe time the account was created in ISO 8601 format, e.g., "2017-07-16T19:20:30Z".
dataJSON objectCustom data. Any data that you want to store regarding the user that isn't part of the Profile or Subscriptions object.
hasFullAccountBooleanIndicates whether this email account is associated with a fully registered account.
hasLiteAccountBooleanIndicates whether this email account is associated with a lite account.
lastUpdatedstringThe time when the email account object was last updated (either full or partial update) in ISO 8601 format, e.g., "2017-07-16T19:20:30Z". This is updated when any change is made to the account, for example, when a user changes their subscription preference.
profileProfile object

The user's profile information.

The email saved in profile.email is unique per email account.

subscriptionsJSON objectAn object containing the subscriptions, if any, to which this email account is subscribed.

 

Response Example

 {
      "createdTimestamp": 1496737083259,
      "subscriptions": {
        "hiSub": {
          "email": {
            "isSubscribed": true,
            "isSubscribedLastUpdated": "2017-06-06T08:18:19.722Z"
          }
        }
      },
      "email": "example@mail.com",
      "created": "2017-06-06T08:18:03.259Z",
      "token": "cf3c1639314319604fdc9ecacef7be467eebd20522f28dd0032592cee6c10758",
      "hasFullAccount": false,
      "lastUpdatedTimestamp": 1496737099722,
      "data": {},
      "lastUpdated": "2017-06-06T08:18:19.722Z",
      "hasLiteAccount": true,
      "channel": "email",
      "profile": {
        "lastName": "no",
        "email": "example@mail.com",
        "firstName": "yes"
      }
    }

 

Query Examples

You can use the Identity Query Tool to retrieve lite account data by using accounts.search. Query examples:

  • Retrieve all email accounts: 

    SELECT * FROM emailAccounts
  • Retrieve all subscribers to a specific newsletter: 

    SELECT * FROM emailAccounts WHERE subscriptions.<NEWSLETTER-NAME>.email.isSubscribed=true
  • Retrieve all subscriptions for an email address: 

    SELECT * FROM emailAccounts WHERE profile.email="<EMAIL-ADDRESS>"
  • Retrieve all users who were created with Lite Registration and are not yet full users: 

    SELECT * FROM emailAccounts WHERE hasLiteAccount=true AND hasFullAccount=false

 

  • No labels