PUT api/v1/admin/fixedmessages

This method modifies an existing fixed message.

Request Information

URI Parameters

None.

Body Parameters

TwoSms.CustomerPortalRole.API.Admin.SMS.FixedMessageModRequest
NameDescriptionTypeAdditional information
ID

ID of fixed message

string

Required

Name

Name given to the fixed message

string

Required

Message

The fixed message

string

Required

Request Formats

application/json, text/json

Sample:
{
  "ID": "sample string 1",
  "Name": "sample string 2",
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:
<FixedMessageModRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 2</Name>
  <Message>sample string 3</Message>
  <ID>sample string 1</ID>
</FixedMessageModRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Object
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Object

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": {}
  }
}

application/xml, text/xml

Sample:
<ResponseOfObject 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 />
  </ResponseData>
</ResponseOfObject>