This method imports lite registration data into the Email Accounts storage. This method imports existing lite registrations into a new or additional database. No double opt-in emails are sent when using this method, and any registrations imported via this method are not considered new registrations for reporting purposes. This is an administrative API and requires a User or Application key with the necessary permissions and can not be called with a partner secret.
Note: If you plan on integrating Gigya's Accounts API, we highly recommend reading the Registration-as-a-Service Guide. Registration-as-a-Service (RaaS) is a premium platform that requires separate activation. If RaaS is not part of your site package, please contact Gigya by filling in a support form through the Console. You can access the support page by clicking Support on the upper menu after logging into the Gigya Console.
us1.gigya.com - For the US data center.
eu1 - For the European data center.
au1 - For the Australian data center.
ru1 - For the Russian data center.
cn1 - For the Chinese data center.
If you are not sure of your site's data center, see Finding Your Data Center.
This method requires HTTPS.
|||email||string||The email address associated with this lite registration.|
|||userKey||string||The user key (or application key) of the user making the request. The userKey is located within the console. Every console user has a userKey generated for them. Additionally, every user with Admin rights to a partner can create application specific user keys via the Manage Applications option under the Admin tab. Once an application is created, the User Key and Secret for that app will be available within the apps settings.|
|||secret||string||The secret associated with the userKey (or application key) making this request.|
||profile||JSON object||The Profile information associated with this lite registration.|
||subscriptions||JSON object||The Subscriptions information associated with this lite registration. Note that a value can be written to the lastUpdatedSubscriptionState parameter when importing lite registrations. Otherwise, this parameter is read-only.|
||data||JSON object||Custom data associated with this lite registration.|
||Determines the format of the response. The options are:
- json (default)
- jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
||This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
||This parameter may be used to pass data through the current method and return it, unchanged, within the response.
||This parameter may be used in order to suppress the showing of screen-sets as a result of API calls. Default is false.
||The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.
Each REST API request must contain identification and authorization parameters.
Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:
Please refer to the Authorization Parameters section for details.
In the following code examples, all references to secret or secretKey are referring to the secret that corresponds to the userKey (Application key) provided in the request, and NOT to your Partner secret located in the Gigya Dashboard.
||The HTTP response code of the operation. Code '200' indicates success.
||The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
||A brief explanation of the status code.
||A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
||This field will appear in the response only in case of an error and will contain the exception info, if available.
||The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
||Unique identifier of the transaction, for debugging purposes.
||The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
A field that does not contain data will not appear in the response.