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

Template
NameDescriptionTypeAdditional 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": "478d81cc-912c-4cd4-ad08-f9f863e49a84",
  "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>478d81cc-912c-4cd4-ad08-f9f863e49a84</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>

Response Information

Resource Description

ResponseOfTemplate
NameDescriptionTypeAdditional 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": "a6d971cb-208c-4031-914a-9bff628cc97c",
      "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>a6d971cb-208c-4031-914a-9bff628cc97c</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>