POST api/v1/admin/templates

Creates a new message template.

Request Information

URI Parameters

None.

Body Parameters

The details of the new message template.

TwoSms.CustomerPortalRole.API.Admin.SMS.MessageTemplateRequest

Name	Description	Type	Additional information
Name	The name for the message template.	string	Required
Template	The message template.	string	Required
Type	Determines which type of messages the template can be used for.	TwoSms.Platform.Database.CustomerPortal.Tables.SMS.MessageTemplateType	Required

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Template": "sample string 2",
  "Type": 1
}

application/xml, text/xml

Sample:

<MessageTemplateRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 1</Name>
  <Template>sample string 2</Template>
  <Type>ALL</Type>
</MessageTemplateRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'TwoSms.CustomerPortalRole.API.Admin.SMS.MessageTemplateRequest'.

Response Information

Resource Description

The ID of the new message template

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.Admin.SMS.MessageTemplateResponse

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.Admin.SMS.MessageTemplateResponse	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": {
      "ID": "98d3bade-a088-4dda-92b8-5b9751c420b8",
      "Enabled": true,
      "Name": "sample string 3",
      "Template": "sample string 4",
      "Type": 1
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfMessageTemplateResponse 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>
      <Name>sample string 3</Name>
      <Template>sample string 4</Template>
      <Type>ALL</Type>
      <ID>98d3bade-a088-4dda-92b8-5b9751c420b8</ID>
      <Enabled>true</Enabled>
    </Detail>
  </ResponseData>
</ResponseOfMessageTemplateResponse>