POST api/mobileapp/magiclink/generate

Generates a magic link for mobile app installation and activation

Request Information

Authentication Method

Partner/Account Authentication

URI Parameters

None.

Body Parameters

Magic Link (Generate)
NameDescriptionTypeAdditional information
userToken

Token of end user

 string

Required

String length: inclusive between 20 and 20
localeCode

Locale code of end user

 string

Required

A valid Locale Code

Request Formats

application/json, text/json

Sample: 
{
  "userToken": "uuuuuuuuuUuuuuuuuuuu",
  "localeCode": "en"
}

application/xml, text/xml

Sample: 
<MagicLinkGenerateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.CreateModels">
  <localeCode>en</localeCode>
  <userToken>uuuuuuuuuUuuuuuuuuuu</userToken>
</MagicLinkGenerateRequest>

Response Information

Successful Response:

Resource Description

Magic Link
NameDescriptionTypeAdditional information
result

If a link was sent via SMS the result will be "Sent" other wise it will be "Generated".

 string

 
link

If the link was only Generated and not Sent it will be supplied here.

 string

 

Response Formats

application/json, text/json

Sample: 
{
  "result": "Generated",
  "link": "https://msa.app.link/AbC123d"
}

application/xml, text/xml

Sample: 
<MagicLink xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <link>https://msa.app.link/AbC123d</link>
  <result>Generated</result>
</MagicLink>