POST api/SMS

Request Information

URI Parameters

None.

Body Parameters

SMSConnector
NameDescriptionTypeAdditional information
PartnerCode

string

None.

AuthCode

string

None.

SerialNumber

string

None.

Enabled

string

None.

PropertyBag

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "PartnerCode": "sample string 1",
  "AuthCode": "sample string 2",
  "SerialNumber": "sample string 3",
  "Enabled": "sample string 4",
  "PropertyBag": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<SMSConnector xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <AuthCode>sample string 2</AuthCode>
  <Enabled>sample string 4</Enabled>
  <PartnerCode>sample string 1</PartnerCode>
  <PropertyBag xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </PropertyBag>
  <SerialNumber>sample string 3</SerialNumber>
</SMSConnector>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SMSRestAPIResponse
NameDescriptionTypeAdditional information
StatusCode

string

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": "sample string 1",
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<SMSRestAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <Message>sample string 2</Message>
  <StatusCode>sample string 1</StatusCode>
</SMSRestAPIResponse>