Register

Registers a lead as a portal user. If the lead already exists in your account, the lead will get updated as a portal user. If the lead doesn’t exist, a new lead will get created in your account.

You may pass additional lead attributes, however, it is mandatory to pass the following attributes in the JSON body –

• mx_Portal_Password
• mx_Portal_Confirm_Password
• Any unique lead identifier in your account (EmailAddress, Phone, mx_PAN_Number, etc.). If you pass multiple unique lead identifiers in the list, the first identifier in the list will be used to search the lead. 

Note: You must pass the public authentication key you receive from the Get Public Auth Key API response. It must be passed in the API header as Authorization = <Your Auth Key>

Here’s an example of an academic portal where a user can register. On clicking the ‘Get Started’ button, the Register API gets called –

API URL

{
   "RegisterOnlyNewLead":true,
   "LeadFields":[
      {
         "Attribute":"mx_Portal_Confirm_Password",
         "Value":"Samplepassword@123"
      },
      {
         "Attribute":"mx_Portal_Password",
         "Value":"Samplepassword@123"
      },
      {
         "Attribute":"EmailAddress",
         "Value":"johnwick@example.com"
      }
   ]
}

{
  "LeadId": "e3e1f3d5-17c7-422e-b2ff-752069e5a010",
  "Message": "Registration Successful"
}