POST api/Common/SendRetailAppLink

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
businessId	integer	None.
userId	integer	None.
retailerId	integer	None.
retailerPhone	string	None.
messageText	string	None.

Request Formats

application/json, text/json

Sample:

{
  "businessId": 1,
  "userId": 2,
  "retailerId": 3,
  "retailerPhone": "sample string 4",
  "messageText": "sample string 5"
}

application/xml, text/xml

Sample:

<SendRetailAppLink xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <businessId>1</businessId>
  <userId>2</userId>
  <retailerId>3</retailerId>
  <retailerPhone>sample string 4</retailerPhone>
  <messageText>sample string 5</messageText>
</SendRetailAppLink>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/04/28 13:42:08",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StatusCode>1</StatusCode>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
</VCAPIResponse>