Gigya Job Openings

accounts.sendLiteInvite REST

Skip to end of metadata
Go to start of metadata

 

This parameter or feature is part of our Early Adopters Program. To find out if you are eligible for participation, contact your Customer Engagement Executive by filling out a support form. You can access the support page by clicking Support on the upper menu after logging into your Gigya Console

Before attempting to use this API you must first activate your Preferences Center by enabling it via the preferencesCenter object of accounts.setPolicies or by entering the redirectURL in the Email Templates section of the Gigya Console. For more information see Lite Preferences Center.

Description

This external API triggers an email from the Gigya server to the email address registered to a lite account. The email contains a clickable link and verifies that the email belongs to the user. The user may click the link to receive an access token that is sent with the user to the page you defined as your Lite Preference Center. The Screen-Sets hosted in your Lite Preference Center will read and validate this token and, on success, allow the user to access and edit their data.

The link within the email is structured like the following:

https://accounts.gigya.com/accounts.verifyLiteInvite?regToken=st2.clFYM8COazU9Z94258vT7l4Q3kM._vo3X1Nu-GLsSRYXEeBypA.FvaaKXXXXXXXXXc9AbAhDaq1IF1o.LUS

Due to this API being external, no authorization parameters (secret or userKey/secret) are required to be sent with the request. However, this API is only valid for lite account users, attempting to use this API with a fully registered account or an unregistered email address will return an errorCode:0, success response, however, no invitation will be sent.

 

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.

Request URL

Where <Data_Center> is:
  • us1.gigya.com - For the US data center.
  • eu1.gigya.com - For the European data center.
  • au1.gigya.com - For the Australian data center.
  • ru1.gigya.com - For the Russian data center.
  • cn1.gigya-api.cn - 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.

Parameters

RequiredNameTypeDescription
emailstring

The email address associated with the lite account you want to send the invitation.

  • Only one of either email or emailToken must be supplied; attempting to send both will cause the call to fail.
emailTokenstring

The emailToken associated with the lite account you want to send the invitation.

  • Only one of either email or emailToken must be supplied; attempting to send both will cause the call to fail.
invitationExpirationintegerThe length of time in seconds the link will remain valid that is inside the email sent to the user in the invitation; the default is 600 (10 minutes).
langstringThe language of the email template to send to the user, the default is "en". Sending an email other than English requires that you have the appropriate template defined in the preferencesCenter object of your Site's Policies.
sessionExpirationintegerThe length of time the user's session will be valid when arriving to your site after clicking the invitation link in the email; the default is 3600 (1 hour).
format string 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).
callback string 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.
context string/JSON This parameter may be used to pass data through the current method and return it, unchanged, within the response.
dontHandleScreenSet Boolean This parameter may be used in order to suppress the showing of screen-sets as a result of API calls. Default is false.
httpStatusCodes Boolean 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.

 

Sample Requests

 

Response Data

FieldTypeDescription
 
errorCode integer 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.
errorMessage string 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.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string 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.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.

 

Response Example

{
  "callId": "6c9ce26d53b1433ab013090506b84738",
  "errorCode": 0,
  "apiVersion": 2,
  "statusCode": 200,
  "statusReason": "OK",
  "time": "2018-07-31T13:00:34.413Z"
}

 

Example Default Email Generated

 

Additional Information

Lite Preferences Center

 

 

 

  • No labels