POST api/mobileapp/magiclink/send

Generates and sends a magic link for mobile app installation and activation via SMS

Request Information

Authentication Method

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
countryCode	Country of end user's SMS number. Only needed if your are not sending the link yourself.	string	Required A valid Country Code
smsNumber	SMS number to which the the magic link should be sent. Only needed if you are not sending the link yourself.	string	Required
message	Body of the SMS message you want sent. Only needed if you are not sending the link yourself. Use {{MagicLink}} to define where in the message the link should be placed.	string	Required
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:

{
  "countryCode": "US",
  "smsNumber": "+15551234567",
  "message": "Here is the app {{MagicLink}}",
  "userToken": "uuuuuuuuuUuuuuuuuuuu",
  "localeCode": "en"
}

application/xml, text/xml

Sample:

<MagicLinkSendRequest 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>
  <countryCode>US</countryCode>
  <message>Here is the app {{MagicLink}}</message>
  <smsNumber>+15551234567</smsNumber>
</MagicLinkSendRequest>

Response Information

Successful Response:

Resource Description

Magic Link

Name	Description	Type	Additional 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>