POST api/Notify/CreateSmsBatch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
NotifyApiKey	string	None.
NotifyTemplateId	string	None.
DeliveryReceiptEmail	string	None.
NotifySmses	Collection of NotifySms	None.
ClientReference	string	None.
Request	date	None.
CostCode	string	None.
CreatedBy	string	None.

Request Formats

application/json, text/json

Sample:

{
  "NotifyApiKey": "sample string 1",
  "NotifyTemplateId": "sample string 2",
  "DeliveryReceiptEmail": "sample string 3",
  "NotifySmses": [
    {
      "MobileNumber": "sample string 1",
      "Text": "sample string 2"
    },
    {
      "MobileNumber": "sample string 1",
      "Text": "sample string 2"
    }
  ],
  "ClientReference": "sample string 4",
  "Request": "2025-10-25T04:24:15.9953265+01:00",
  "CostCode": "sample string 6",
  "CreatedBy": "sample string 7"
}

text/html

Sample:

{"NotifyApiKey":"sample string 1","NotifyTemplateId":"sample string 2","DeliveryReceiptEmail":"sample string 3","NotifySmses":[{"MobileNumber":"sample string 1","Text":"sample string 2"},{"MobileNumber":"sample string 1","Text":"sample string 2"}],"ClientReference":"sample string 4","Request":"2025-10-25T04:24:15.9953265+01:00","CostCode":"sample string 6","CreatedBy":"sample string 7"}

application/xml, text/xml

Sample:

<NotifySmsBatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <ClientReference>sample string 4</ClientReference>
  <CostCode>sample string 6</CostCode>
  <CreatedBy>sample string 7</CreatedBy>
  <DeliveryReceiptEmail>sample string 3</DeliveryReceiptEmail>
  <NotifyApiKey>sample string 1</NotifyApiKey>
  <NotifySmses>
    <NotifySms>
      <MobileNumber>sample string 1</MobileNumber>
      <Text>sample string 2</Text>
    </NotifySms>
    <NotifySms>
      <MobileNumber>sample string 1</MobileNumber>
      <Text>sample string 2</Text>
    </NotifySms>
  </NotifySmses>
  <NotifyTemplateId>sample string 2</NotifyTemplateId>
  <Request>2025-10-25T04:24:15.9953265+01:00</Request>
</NotifySmsBatch>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.