POST api/v1/sms/templates

This method creates a new notification template that will overwrite the system default notification template for the specified type.

Request Information

URI Parameters

None.

Body Parameters

Either xml or json request

Template

Name	Description	Type	Additional information
TemplateID	The unique identifier for the template.	globally unique identifier	Required
Name	The name of the template	string	Required
Type	Determines if the template is used for the Sms, EMAiL or SMSPLUS messages.	TemplateType	Required
TemplateText	The actual template.	string	Required
DateCreated	The actual date the template was created.	string	Required
DateModified	The date the template was last modified.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "TemplateID": "8db3c58a-1b7a-4dfe-8fce-b8aa34f4c512",
  "Name": "sample string 2",
  "Type": 0,
  "TemplateText": "sample string 3",
  "DateCreated": "sample string 4",
  "DateModified": "sample string 5"
}

application/xml, text/xml

Sample:

<Template xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>8db3c58a-1b7a-4dfe-8fce-b8aa34f4c512</ID>
  <Name>sample string 2</Name>
  <Type>RECIPIENT_CODE</Type>
  <TemplateText>sample string 3</TemplateText>
  <DateCreated>sample string 4</DateCreated>
  <DateModified>sample string 5</DateModified>
</Template>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfTemplate

Name	Description	Type	Additional information
Error		Error	None.
ResponseData		ResponseDataOfTemplate	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "TemplateID": "6bc17c12-8c49-4043-b506-ffc35a341d49",
      "Name": "sample string 2",
      "Type": 0,
      "TemplateText": "sample string 3",
      "DateCreated": "sample string 4",
      "DateModified": "sample string 5"
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfTemplate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <ID>6bc17c12-8c49-4043-b506-ffc35a341d49</ID>
      <Name>sample string 2</Name>
      <Type>RECIPIENT_CODE</Type>
      <TemplateText>sample string 3</TemplateText>
      <DateCreated>sample string 4</DateCreated>
      <DateModified>sample string 5</DateModified>
    </Detail>
  </ResponseData>
</ResponseOfTemplate>