POST api/v1/addressbook/stoplog

Adds a number(s) to the 2sms stop log on a given short code. Each number is then sent a confirmation informing the user that they have been opt out of the short code.

Request Information

URI Parameters

None.

Body Parameters

The list of numbers with short codes to opt out.

Collection of StopLogMobileRecord

Name	Description	Type	Additional information
Destination	The number to add or remove from the 2sms stop log.	string	Required
Reason	The reason why the number is to be added or removed from the 2sms stop log.	string	Required
SendConfirmation	Determine if a confirmation message is sent to the number to confirm addition or removal from the 2sms Stop Log. For this to work, the client must have signed a separate agreement.	boolean	None.
ShortCode	The short code for the number to be added or removed from the 2sms stop log.	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "Destination": "sample string 1",
    "Reason": "sample string 2",
    "SendConfirmation": true,
    "ShortCode": "sample string 4"
  },
  {
    "Destination": "sample string 1",
    "Reason": "sample string 2",
    "SendConfirmation": true,
    "ShortCode": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfStopLogMobileRecord xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StopLogMobileRecord>
    <Destination>sample string 1</Destination>
    <Reason>sample string 2</Reason>
    <SendConfirmation>true</SendConfirmation>
    <ShortCode>sample string 4</ShortCode>
  </StopLogMobileRecord>
  <StopLogMobileRecord>
    <Destination>sample string 1</Destination>
    <Reason>sample string 2</Reason>
    <SendConfirmation>true</SendConfirmation>
    <ShortCode>sample string 4</ShortCode>
  </StopLogMobileRecord>
</ArrayOfStopLogMobileRecord>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The status of the numbers in the stop log.

ResponseOfStopLogResponse

Name	Description	Type	Additional information
Error		Error	None.
ResponseData		ResponseDataOfStopLogResponse	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": {
      "Records": [
        {
          "Destination": "sample string 1",
          "MessageID": "sample string 2",
          "Status": "sample string 3",
          "ShortCode": "sample string 4"
        },
        {
          "Destination": "sample string 1",
          "MessageID": "sample string 2",
          "Status": "sample string 3",
          "ShortCode": "sample string 4"
        }
      ],
      "CreditsUsed": 1.1,
      "CreditsRemaining": 2.1
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfStopLogResponse 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>
      <Records>
        <StopLogMobileRecordResult>
          <Destination>sample string 1</Destination>
          <MessageID>sample string 2</MessageID>
          <Status>sample string 3</Status>
          <ShortCode>sample string 4</ShortCode>
        </StopLogMobileRecordResult>
        <StopLogMobileRecordResult>
          <Destination>sample string 1</Destination>
          <MessageID>sample string 2</MessageID>
          <Status>sample string 3</Status>
          <ShortCode>sample string 4</ShortCode>
        </StopLogMobileRecordResult>
      </Records>
      <CreditsUsed>1.1</CreditsUsed>
      <CreditsRemaining>2.1</CreditsRemaining>
    </Detail>
  </ResponseData>
</ResponseOfStopLogResponse>