Syntch Gateway API

<back to all web services

ContactUsRequest

Support - Contact Us
Requires Authentication
Required role:Merchant
The following routes are available for this service:
POST/users/{userKey}/contact-usSend a message from the user to support contact.
ContactUsRequest Parameters:
NameParameterData TypeRequiredDescription
UserKeypathintYes
MerchantKeymodelintYes
UserMessagemodelstringYes
ToAddressmodelstringYes
CCAddressmodelstringNo
BCCAddressmodelstringNo
LanguageCodemodelLanguageCodeNo
LanguageCode Enum:
en_us
CommunicationStatus Parameters:
NameParameterData TypeRequiredDescription
StatusCodeformintNo
StatusStringformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /users/{userKey}/contact-us HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ContactUsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Users.BindingModels">
  <BCCAddress>String</BCCAddress>
  <CCAddress>String</CCAddress>
  <LanguageCode>en_us</LanguageCode>
  <MerchantKey>0</MerchantKey>
  <ToAddress>String</ToAddress>
  <UserKey>0</UserKey>
  <UserMessage>String</UserMessage>
</ContactUsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommunicationStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.Infrastructure.Common">
  <StatusCode>0</StatusCode>
  <StatusString>String</StatusString>
</CommunicationStatus>