POST api/SMS

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	string	None.
CustomerID	integer	None.
UserID	integer	None.
SyncProfileID	integer	None.
ContactExternalReference	string	None.
ContactExternalSchema	string	None.
RegardingReference	string	None.
RegardingSchema	string	None.
RegardingName	string	None.
SMSExternalReference	string	None.
CampaignExternalReference	string	None.
FromNumber	string	None.
ToNumber	string	None.
Message	string	None.
Direction	Directions	None.
SMSReference	string	None.
ContactReference	string	None.
SendRecievedDate	date	None.
IsPartSynced	boolean	None.
IsStop	boolean	None.
IsStart	boolean	None.
TotalOutboundSMS	integer	None.
TotalInboundSMS	integer	None.
TotalFailedSMS	integer	None.
TotalLinksSent	integer	None.
TotalDistinctLinkClicks	integer	None.
EngagementRating	decimal number	None.
CostLocal	decimal number	None.
SyncUserID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": "sample string 1",
  "CustomerID": 2,
  "UserID": 3,
  "SyncProfileID": 4,
  "ContactExternalReference": "sample string 5",
  "ContactExternalSchema": "sample string 6",
  "RegardingReference": "sample string 7",
  "RegardingSchema": "sample string 8",
  "RegardingName": "sample string 9",
  "SMSExternalReference": "sample string 10",
  "CampaignExternalReference": "sample string 11",
  "FromNumber": "sample string 12",
  "ToNumber": "sample string 13",
  "Message": "sample string 14",
  "Direction": 0,
  "SMSReference": "sample string 15",
  "ContactReference": "sample string 16",
  "SendRecievedDate": "2025-12-11T02:11:48.6222621+00:00",
  "IsPartSynced": true,
  "IsStop": true,
  "IsStart": true,
  "TotalOutboundSMS": 21,
  "TotalInboundSMS": 22,
  "TotalFailedSMS": 23,
  "TotalLinksSent": 24,
  "TotalDistinctLinkClicks": 25,
  "EngagementRating": 26.1,
  "CostLocal": 27.0,
  "SyncUserID": "sample string 28"
}

application/xml, text/xml

Sample:

<SMSSync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/txtsync_dynamics_webproxy.Models">
  <CampaignExternalReference>sample string 11</CampaignExternalReference>
  <ContactExternalReference>sample string 5</ContactExternalReference>
  <ContactExternalSchema>sample string 6</ContactExternalSchema>
  <ContactReference>sample string 16</ContactReference>
  <CostLocal>27</CostLocal>
  <CustomerID>2</CustomerID>
  <Direction>Outboundbound</Direction>
  <EngagementRating>26.1</EngagementRating>
  <FromNumber>sample string 12</FromNumber>
  <ID>sample string 1</ID>
  <IsPartSynced>true</IsPartSynced>
  <IsStart>true</IsStart>
  <IsStop>true</IsStop>
  <Message>sample string 14</Message>
  <RegardingName>sample string 9</RegardingName>
  <RegardingReference>sample string 7</RegardingReference>
  <RegardingSchema>sample string 8</RegardingSchema>
  <SMSExternalReference>sample string 10</SMSExternalReference>
  <SMSReference>sample string 15</SMSReference>
  <SendRecievedDate>2025-12-11T02:11:48.6222621+00:00</SendRecievedDate>
  <SyncProfileID>4</SyncProfileID>
  <SyncUserID>sample string 28</SyncUserID>
  <ToNumber>sample string 13</ToNumber>
  <TotalDistinctLinkClicks>25</TotalDistinctLinkClicks>
  <TotalFailedSMS>23</TotalFailedSMS>
  <TotalInboundSMS>22</TotalInboundSMS>
  <TotalLinksSent>24</TotalLinksSent>
  <TotalOutboundSMS>21</TotalOutboundSMS>
  <UserID>3</UserID>
</SMSSync>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SMSSync'.

Response Information

Resource Description

SMSSync

Name	Type	Additional information
ID	string	None.
CustomerID	integer	None.
UserID	integer	None.
SyncProfileID	integer	None.
ContactExternalReference	string	None.
ContactExternalSchema	string	None.
RegardingReference	string	None.
RegardingSchema	string	None.
RegardingName	string	None.
SMSExternalReference	string	None.
CampaignExternalReference	string	None.
FromNumber	string	None.
ToNumber	string	None.
Message	string	None.
Direction	Directions	None.
SMSReference	string	None.
ContactReference	string	None.
SendRecievedDate	date	None.
IsPartSynced	boolean	None.
IsStop	boolean	None.
IsStart	boolean	None.
TotalOutboundSMS	integer	None.
TotalInboundSMS	integer	None.
TotalFailedSMS	integer	None.
TotalLinksSent	integer	None.
TotalDistinctLinkClicks	integer	None.
EngagementRating	decimal number	None.
CostLocal	decimal number	None.
SyncUserID	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "sample string 1",
  "CustomerID": 2,
  "UserID": 3,
  "SyncProfileID": 4,
  "ContactExternalReference": "sample string 5",
  "ContactExternalSchema": "sample string 6",
  "RegardingReference": "sample string 7",
  "RegardingSchema": "sample string 8",
  "RegardingName": "sample string 9",
  "SMSExternalReference": "sample string 10",
  "CampaignExternalReference": "sample string 11",
  "FromNumber": "sample string 12",
  "ToNumber": "sample string 13",
  "Message": "sample string 14",
  "Direction": 0,
  "SMSReference": "sample string 15",
  "ContactReference": "sample string 16",
  "SendRecievedDate": "2025-12-11T02:11:48.6222621+00:00",
  "IsPartSynced": true,
  "IsStop": true,
  "IsStart": true,
  "TotalOutboundSMS": 21,
  "TotalInboundSMS": 22,
  "TotalFailedSMS": 23,
  "TotalLinksSent": 24,
  "TotalDistinctLinkClicks": 25,
  "EngagementRating": 26.1,
  "CostLocal": 27.0,
  "SyncUserID": "sample string 28"
}

application/xml, text/xml

Sample:

<SMSSync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/txtsync_dynamics_webproxy.Models">
  <CampaignExternalReference>sample string 11</CampaignExternalReference>
  <ContactExternalReference>sample string 5</ContactExternalReference>
  <ContactExternalSchema>sample string 6</ContactExternalSchema>
  <ContactReference>sample string 16</ContactReference>
  <CostLocal>27</CostLocal>
  <CustomerID>2</CustomerID>
  <Direction>Outboundbound</Direction>
  <EngagementRating>26.1</EngagementRating>
  <FromNumber>sample string 12</FromNumber>
  <ID>sample string 1</ID>
  <IsPartSynced>true</IsPartSynced>
  <IsStart>true</IsStart>
  <IsStop>true</IsStop>
  <Message>sample string 14</Message>
  <RegardingName>sample string 9</RegardingName>
  <RegardingReference>sample string 7</RegardingReference>
  <RegardingSchema>sample string 8</RegardingSchema>
  <SMSExternalReference>sample string 10</SMSExternalReference>
  <SMSReference>sample string 15</SMSReference>
  <SendRecievedDate>2025-12-11T02:11:48.6222621+00:00</SendRecievedDate>
  <SyncProfileID>4</SyncProfileID>
  <SyncUserID>sample string 28</SyncUserID>
  <ToNumber>sample string 13</ToNumber>
  <TotalDistinctLinkClicks>25</TotalDistinctLinkClicks>
  <TotalFailedSMS>23</TotalFailedSMS>
  <TotalInboundSMS>22</TotalInboundSMS>
  <TotalLinksSent>24</TotalLinksSent>
  <TotalOutboundSMS>21</TotalOutboundSMS>
  <UserID>3</UserID>
</SMSSync>