Home → Event Plugin → API Calls → api/PluginCreateLoginToken - Check Email and Retrieve Login Token

1.1. api/PluginCreateLoginToken - Check Email and Retrieve Login Token

This API call is used to check if an email address is recognised/already associated with a contact record within the CRM.

If the email is found, you can use the returned login token with api/PluginSubmitLoginToken.

Please note the details provided in api/PluginCreateLoginToken are valid for a total of 1 hour and usable with api/PluginSubmitLoginToken for said timeframe. If expired, api/PluginCreateLoginToken must be recalled, retrieving new details.

 

---

 

Parameters To Submit

The parameter cannot be submitted as a blank value.

Parameter	Parameter Help	Parameter Data Type
emailaddress	Registering user’s email address.	String – Max 250 chars
API Key

 

---

 

Return Response

The API call ResponseMessage will return the following fields of data.

Field	Field Help
uid	The contact’s uid.
Company	The primary record/company the contact is associated with.
LoginVerified	True/False value indicating if the email address has been verified.
LoginTokenVal	This Val is required as part of api/PluginSubmitLoginToken.
LoginTokenID	This ID is required as part of api/PluginSubmitLoginToken.

 

If 0 items are returned, the email address is not recognised.