# info.description
SMS API contains methods used to send notifications via Short Message Service, directly to your client's phone

# paths./campaigns.get.description
This method returns the list of SMS campaigns for client profile. Results are split into pages, size of each is defined by request query.

# paths./campaigns.get.parameters[].description
The results page to retrieve. It has to be a positive integer.

# paths./campaigns.get.parameters[].description
The number of records to retrieve per results page. Should be an integer value between 10 and 1000.

# paths./campaigns.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./campaigns.get.responses.200.description
Method was successfully invoked. Response body contains the list of client SMS details, ordered by date (descending). Besides actual data, response body contains additional information about data - current data page, page size, total number of pages and total number of records available.

# paths./campaigns.get.responses.200.content.application/json.example.Data[].Content
Don't miss next week descounts - up to 70% in our stores

# paths./campaigns.get.responses.400.description
An error occurred while making list create request. Please check response body to find additional details about error.

# paths./campaigns.get.responses.400.content.application/json.example.Message
Record page number must be a positive integer value

# paths./campaigns.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./campaigns/{campaignId}.get.description
This method returns detailed information about requested SMS campaign.

# paths./campaigns/{campaignId}.get.parameters[].description
ID value of the campaign, details are fetched for

# paths./campaigns/{campaignId}.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./campaigns/{campaignId}.get.responses.200.description
Method was successfully invoked. Response body contains details information about requested SMS Campaign.

# paths./campaigns/{campaignId}.get.responses.200.content.application/json.example.Content
Don't miss next week of up to 70% discount in our stores

# paths./campaigns/{campaignId}.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./campaigns/{campaignId}.get.responses.404.description
SMS campaign with specified ID value does not exist.

# paths./campaigns/{campaignId}.get.responses.404.content.application/json.example.Message
Campaign with provided ID value does not exist

# paths./campaigns/{campaignId}/webhooks.get.description
This method returns the list of webhook records for campaign specified by its ID value

# paths./campaigns/{campaignId}/webhooks.get.parameters[].description
ID value of SMS campaign, results are to be fetched for

# paths./campaigns/{campaignId}/webhooks.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./campaigns/{campaignId}/webhooks.get.responses.200.description
Method was successfully invoked. Response body contains the list of webhooks present for specified campaign.

# paths./campaigns/{campaignId}/webhooks.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./campaigns/{campaignId}/webhooks.get.responses.404.description
SMS campaign with specified ID value does not exist

# paths./campaigns/{campaignId}/webhooks.get.responses.404.content.application/json.example.Message
Campaign with provided ID value does not exist

# paths./campaigns/{campaignId}/webhooks.post.description
This method creates new campaign webhook record for specified campaign. Request body is to contain information required to create new webhook instance - url and webhook type.
If successfully created, when sent message status is updated, message is to be sent to specified url:
{
  "Timestamp": "2021-12-08T15:09:24.9724224Z",
  "Type": "CampaignMessageStatusUpdate",
  "Events": [
    {
      "Number": "27728374958",
      "Status": "Enroute"
    },
    {
      "Number": "27722738495",
      "Status": "Delivered"
    },
    {
        "Number": "27720293845",
        "Status": "Delivered"
    }
  ]
}

Events are dispatched usually a few seconds after being received. Also, they're aggregated - a single notification contains array of up to 500 events.
Each event contains phone number and current message status. For CampaignReply webhook type, there's also a 'Message' field in each event instance, containing received reply text.
Type field designates webhook type - in this case 'CampaignMessageStatusUpdate'.

# paths./campaigns/{campaignId}/webhooks.post.parameters[].description
ID value of SMS campaign, new webhook is to be created for

# paths./campaigns/{campaignId}/webhooks.post.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./campaigns/{campaignId}/webhooks.post.requestBody.description
New campaign webhook request should contain a JSON object with webhook type and url properties set. Allowed webhook types are: 'CampaignReply' and 'CampaignMessageStatusUpdate'

# paths./campaigns/{campaignId}/webhooks.post.responses.201.description
New SMS campaign webhook has been created. Response body contains new record, and Location header contains its url

# paths./campaigns/{campaignId}/webhooks.post.responses.400.description
An error occurred while making campaign webhook create request. Please check response body to find additional details about error.

# paths./campaigns/{campaignId}/webhooks.post.responses.400.content.application/json.example.Message
Webhook URL is too long. It must not be longer then 512 characters

# paths./campaigns/{campaignId}/webhooks.post.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./campaigns/{campaignId}/webhooks.post.responses.404.description
SMS campaign with specified ID value does not exist

# paths./campaigns/{campaignId}/webhooks.post.responses.404.content.application/json.example.Message
Campaign with provided ID value does not exist

# paths./campaigns/{campaignId}/webhooks.post.responses.409.description
Creating new webhook record has failed due to database constraint. Please check out response body for more details

# paths./campaigns/{campaignId}/webhooks.post.responses.409.content.application/json.example.Message
Campaign with provided ID value already has a webhook instance with specified type

# paths./campaigns/{campaignId}/webhooks/{webhookId}.get.description
This method returns detailed information for specific campaign webhook (identified by its ID value).

# paths./campaigns/{campaignId}/webhooks/{webhookId}.get.parameters[].description
ID value of SMS campaign webhook record is associated with

# paths./campaigns/{campaignId}/webhooks/{webhookId}.get.parameters[].description
ID value of SMS webhook details are to be fetched for

# paths./campaigns/{campaignId}/webhooks/{webhookId}.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./campaigns/{campaignId}/webhooks/{webhookId}.get.responses.200.description
Method was successfully invoked and response body contains detailed information about requested webhook

# paths./campaigns/{campaignId}/webhooks/{webhookId}.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./campaigns/{campaignId}/webhooks/{webhookId}.get.responses.404.description
Campaign webhook list with specified ID value does not exist.

# paths./campaigns/{campaignId}/webhooks/{webhookId}.delete.description
This method removes existing campaign webhook record. No further event notifications will be sent for that webhook

# paths./campaigns/{campaignId}/webhooks/{webhookId}.delete.parameters[].description
ID value of SMS campaign, webhook record is associated with

# paths./campaigns/{campaignId}/webhooks/{webhookId}.delete.parameters[].description
ID value of SMS campaign webhook to update

# paths./campaigns/{campaignId}/webhooks/{webhookId}.delete.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./campaigns/{campaignId}/webhooks/{webhookId}.delete.responses.204.description
Webhook record has been successfully deleted.

# paths./campaigns/{campaignId}/webhooks/{webhookId}.delete.responses.400.description
An error occurred while making webhook delete request. Please check response body to find additional details about error.

# paths./campaigns/{campaignId}/webhooks/{webhookId}.delete.responses.400.content.application/json.example.Message
Webhook ID value is to be a positive integer value

# paths./campaigns/{campaignId}/webhooks/{webhookId}.delete.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./campaigns/{campaignId}/webhooks/{webhookId}.delete.responses.404.description
Campaign webhook record with specified ID value does not exist

# paths./campaigns/{campaignId}/webhooks/{webhoookId}.put.description
This method updates existing campaign webhook. Request body contains webhook data. Properties allowed to be updated include webhook Url and active status ('IsActive' property). The latter can have both values (true or false), to activate or deactivate existing webhook, respectively

# paths./campaigns/{campaignId}/webhooks/{webhoookId}.put.parameters[].description
ID value of SMS campaign, webhook record is assocated with

# paths./campaigns/{campaignId}/webhooks/{webhoookId}.put.parameters[].description
ID value of SMS campaign webhook to update

# paths./campaigns/{campaignId}/webhooks/{webhoookId}.put.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./campaigns/{campaignId}/webhooks/{webhoookId}.put.requestBody.description
SMS campaign webhook record containing values to update specified webhook instance

# paths./campaigns/{campaignId}/webhooks/{webhoookId}.put.responses.200.description
Webhook update was successful. Response body contains updated record.

# paths./campaigns/{campaignId}/webhooks/{webhoookId}.put.responses.400.description
An error occurred while making webhook update request. Please check response body to find additional details about error.

# paths./campaigns/{campaignId}/webhooks/{webhoookId}.put.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./campaigns/{campaignId}/webhooks/{webhoookId}.put.responses.404.description
Campaign webhook with specified ID value does not exist.

# paths./lists/{listId}/webhooks.get.description
This method returns the list of webhook records for subscriber list specified by its ID value

# paths./lists/{listId}/webhooks.get.parameters[].description
ID value of SMS subscriber list, webhooks are to be fetched for

# paths./lists/{listId}/webhooks.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/webhooks.get.responses.200.description
Method was successfully invoked. Response body contains the list of webhooks present for specified subscriber list.

# paths./lists/{listId}/webhooks.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./lists/{listId}/webhooks.get.responses.404.description
SMS subscriber list with specified ID value does not exist

# paths./lists/{listId}/webhooks.get.responses.404.content.application/json.example.Message
List with provided ID value does not exist

# paths./lists/{listId}/webhooks.post.description
This method creates new subscriber list webhook record for specified list. Request body is to contain information required to create new webhook instance - url and webhook type.
If successfully created, when sent message status is updated, message is to be sent to specified url:
{
  "Timestamp": "2021-12-08T15:09:24.9724224Z",
  "Type": "ListSubscribe",
  "Events": [
    {
      "Number": "27728374958"
    },
    {
      "Number": "27722738495"
    },
    {
        "Number": "27720293845"
    }
  ]
}

Events are dispatched usually a few seconds after being received. Also, they're aggregated - a single notification contains array of up to 500 events.
Each event contains phone number of new or unsubscribed subscriber.
Type field designates webhook type - in this case 'ListSubscribe'.

# paths./lists/{listId}/webhooks.post.parameters[].description
ID value of SMS subscriber list, new webhook is to be created for

# paths./lists/{listId}/webhooks.post.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/webhooks.post.requestBody.description
New list webhook request should contain a JSON object with webhook type and url properties set. Allowed webhook types are: 'ListSubscribe' and 'ListUnsubscribe'

# paths./lists/{listId}/webhooks.post.responses.201.description
New SMS list webhook has been created. Response body contains new record, and Location header contains its url

# paths./lists/{listId}/webhooks.post.responses.400.description
An error occurred while making list webhook create request. Please check response body to find additional details about error.

# paths./lists/{listId}/webhooks.post.responses.400.content.application/json.example.Message
Webhook URL is too long. It must not be longer then 512 characters

# paths./lists/{listId}/webhooks.post.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./lists/{listId}/webhooks.post.responses.404.description
SMS subscriber list with specified ID value does not exist

# paths./lists/{listId}/webhooks.post.responses.404.content.application/json.example.Message
List with provided ID value does not exist

# paths./lists/{listId}/webhooks.post.responses.409.description
Creating new webhook record has failed due to database constraint. Please check out response body for more details

# paths./lists/{listId}/webhooks.post.responses.409.content.application/json.example.Message
List with provided ID value already has a webhook instance with specified type

# paths./lists/{listId}/webhooks/{webhookId}.get.description
This method returns detailed information for specific list webhook (identified by its ID value).

# paths./lists/{listId}/webhooks/{webhookId}.get.parameters[].description
ID value of SMS subscriber list, that webhook record is associated with

# paths./lists/{listId}/webhooks/{webhookId}.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/webhooks/{webhookId}.get.responses.200.description
Method was successfully invoked and response body contains detailed information about requested webhook

# paths./lists/{listId}/webhooks/{webhookId}.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./lists/{listId}/webhooks/{webhookId}.get.responses.404.description
List webhook list with specified ID value does not exist.

# paths./lists/{listId}/webhooks/{webhookId}.put.description
This method updates existing list webhook. Request body contains webhook data. Properties allowed to be updated include webhook Url and active status ('IsActive' property). The latter can have both values (true or false), to activate or deactivate existing webhook, respectively

# paths./lists/{listId}/webhooks/{webhookId}.put.parameters[].description
ID value of SMS subscriber list, that webhook record is assocated with

# paths./lists/{listId}/webhooks/{webhookId}.put.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/webhooks/{webhookId}.put.requestBody.description
SMS list webhook record containing values to update specified webhook instance

# paths./lists/{listId}/webhooks/{webhookId}.put.responses.200.description
Webhook update was successful. Response body contains updated record.

# paths./lists/{listId}/webhooks/{webhookId}.put.responses.400.description
An error occurred while making webhook update request. Please check response body to find additional details about error.

# paths./lists/{listId}/webhooks/{webhookId}.put.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./lists/{listId}/webhooks/{webhookId}.put.responses.404.description
List webhook with specified ID value does not exist.

# paths./lists/{listId}/webhooks/{webhookId}.delete.description
This method removes existing list webhook record. No further event notifications will be sent for that webhook

# paths./lists/{listId}/webhooks/{webhookId}.delete.parameters[].description
ID value of SMS subscriber list, that webhook record is associated with

# paths./lists/{listId}/webhooks/{webhookId}.delete.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/webhooks/{webhookId}.delete.responses.204.description
Webhook record has been successfully deleted.

# paths./lists/{listId}/webhooks/{webhookId}.delete.responses.400.description
An error occurred while making webhook delete request. Please check response body to find additional details about error.

# paths./lists/{listId}/webhooks/{webhookId}.delete.responses.400.content.application/json.example.Message
Webhook ID value is to be a positive integer value

# paths./lists/{listId}/webhooks/{webhookId}.delete.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./lists/{listId}/webhooks/{webhookId}.delete.responses.404.description
List webhook record with specified ID value does not exist

# paths./campaigns/{campaignId}/report.get.description
This method returns campaign report. Report always contains campaign name, status, number of recipients, number of delivered and bounced messages, number of replies and recipients that decided to unsubscribe. Based on 'select' query parameter, for each of the last 5 numeric values, a detailed information can be returned (a list of records). For all but replies, detailed information contains recipient phone number and a date when event happened. For replies, actual message text is also present.

# paths./campaigns/{campaignId}/report.get.parameters[].description
ID value of campaign report is requested for. Please use 'Get SMS Campaigns' method to return a list of campaigns with associated ID values

# paths./campaigns/{campaignId}/report.get.parameters[].description
An integer value that designates what detailed data report should contain. Each additional detail to get is represented with numeric value. Combine one or more by adding their respective numeric values and using result sum:
- Value [1] to return the list of recipients
- Value [2] to return the list of numbers message got delivered
- Value [4] to return the list of numbers for which delivery failed
- Value [8] to return the list of replies received and
- Value [16] to return the list of numbers that got unsubscribed

# paths./campaigns/{campaignId}/report.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./campaigns/{campaignId}/report.get.responses.200.description
Report was successfully created. Response body contains the data

# paths./campaigns/{campaignId}/report.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./message.post.description
This method initiates sending SMS to specified phone number. Long messages are automatically split into fragments. Sending takes place if there is enough credits in your account - you need to have at least as many credits as there are message fragments. Unicode is not currently supported - only standard GSM alphabet.

# paths./message.post.parameters[].description
When set to true, suppression list is ignored, otherwise number (that SMS is being sent to) is compared against suppression list and only if it's not in the list, SMS is sent to recipient. If mobile number is in suppression list, 403 error is returned

# paths./message.post.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./message.post.requestBody.description
Request body must contain a JSON object with the following properties:
- Number: recipient phone number; can contain leading '+' symbol, but doesn't need to, and 
- Text: Message text
- Id: Optional user-assigned message ID value

# paths./message.post.responses.200.description
Message was successfully scheduled for sending. Response body contains details about the message. Message has an initial status - "Accepted", meaning it's accepted by our SMS service and is about to be dispatched to recipient. Each message status is updated according to delivery status. Possible values are:

- Enroute,
- Delivered,
- Expired,
- Deleted,
- Undeliverable,
- Accepted,
- Unknown,
- Rejected or
- Waiting (for delivery)

In order to check current message status, another method is to be called, to read message details. Use MessageId value returned in response body. Please have in mind that some characters increase message length by 2 due to special handling: ^|€{}[]\~

# paths./message.post.responses.400.description
An error occurred while making SMS send request. Please check response body to find additional details about error.

# paths./message.post.responses.401.description
Provided API credentials is not valid. Please check out response body for more details

# paths./message.post.responses.403.description
Message sending not allowed due to insufficient credits in your account, or message recipient is in suppression list and "send2Suppressed" parameter is set to "false" (response body contains actual reason)

# paths./message/{messageId}.get.description
Use this method to get message details - check for current message status.

# paths./message/{messageId}.get.parameters[].description
ID value of the SMS details are fetched for. It is part of response body when sending SMS

# paths./message/{messageId}.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./message/{messageId}.get.responses.200.description
Message details were found and contained in response body.

# paths./message/{messageId}.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details

# paths./message/{messageId}.get.responses.404.description
Message with specified ID value does not exist

# paths./message/webhooks.post.description
This method creates new webhook record for receiving notifications about individual message status updates or for being notified about received replies. Request body is to contain information required to create new webhook instance - url and a webhook type.
If successfully created, when sent message status is updated, message is to be sent to specified url:
{
  "Timestamp": "2021-12-08T15:09:24.9724224Z",
  "Type": "MessageStatusUpdate",
  "Events": [
    {
      "Number": "27728374958",
      "Status": "Enroute"
    },
    {
      "Number": "27722738495",
      "Status": "Delivered"
    },
    {
        "Number": "27720293845",
        "Status": "Delivered",
        "Id": "slkedfjo938urxcvx9ejos"
    }
  ]
}

Events are dispatched usually a few seconds after being received. Also, they're aggregated - a single notification contains array of up to 500 events.
Each event contains phone number and current message status. Also, if external message ID was provided, it will be appended to "Number" field.
Type field designates webhook type - in this case MessageStatusUpdate or MessageReply.

# paths./message/webhooks.post.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./message/webhooks.post.requestBody.description
New campaign webhook request should contain a JSON object with webhook type and url properties set. Allowed webhook types are: 'MessageStatusUpdate' and 'MessageReply'

# paths./message/webhooks.post.responses.201.description
New SMS message status webhook has been created. Response body contains new record, and Location header contains its url

# paths./message/webhooks.post.responses.400.description
An error occurred while making campaign webhook create request. Please check response body to find additional details about error.

# paths./message/webhooks.post.responses.400.content.application/json.example.Message
Webhook URL is too long. It must not be longer then 512 characters

# paths./message/webhooks.post.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./message/webhooks.get.description
This method returns the list of message status update webhook records

# paths./message/webhooks.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./message/webhooks.get.responses.200.description
Method was successfully invoked. Response body contains the list of webhooks present.

# paths./message/webhooks.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./message/webhooks/{webhookId}.get.description
This method returns detailed information for specific message status webhook (identified by its ID value).

# paths./message/webhooks/{webhookId}.get.parameters[].description
ID value of SMS webhook details are to be fetched for

# paths./message/webhooks/{webhookId}.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./message/webhooks/{webhookId}.get.responses.200.description
Method was successfully invoked and response body contains detailed information about requested webhook

# paths./message/webhooks/{webhookId}.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./message/webhooks/{webhookId}.get.responses.404.description
Message webhook with specified ID value does not exist.

# paths./message/webhooks/{webhookId}.delete.description
This method removes existing message webhook record. No further event notifications will be sent for that webhook

# paths./message/webhooks/{webhookId}.delete.parameters[].description
ID value of SMS campaign webhook to update

# paths./message/webhooks/{webhookId}.delete.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./message/webhooks/{webhookId}.delete.responses.204.description
Webhook record has been successfully deleted.

# paths./message/webhooks/{webhookId}.delete.responses.400.description
An error occurred while making webhook delete request. Please check response body to find additional details about error.

# paths./message/webhooks/{webhookId}.delete.responses.400.content.application/json.example.Message
Webhook ID value is to be a positive integer value

# paths./message/webhooks/{webhookId}.delete.responses.401.description
Provided API credential is not valid. Please check out response body for more details.

# paths./message/webhooks/{webhookId}.delete.responses.404.description
Message webhook record with specified ID value does not exist

# paths./message/webhooks/{webhookId}.put.description
This method updates existing message webhook. Request body contains webhook data. Properties allowed to be updated include webhook Url and active status ('IsActive' property). The latter can have both values (true or false), to activate or deactivate existing webhook, respectively

# paths./message/webhooks/{webhookId}.put.parameters[].description
ID value of SMS campaign webhook to update

# paths./message/webhooks/{webhookId}.put.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./message/webhooks/{webhookId}.put.requestBody.description
SMS message webhook record, containing values to update specified instance

# paths./message/webhooks/{webhookId}.put.responses.200.description
Webhook update was successful. Response body contains updated record.

# paths./message/webhooks/{webhookId}.put.responses.400.description
An error occurred while making webhook update request. Please check response body to find additional details about error.

# paths./message/webhooks/{webhookId}.put.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./message/webhooks/{webhookId}.put.responses.404.description
Message webhook with specified ID value does not exist.

# paths./balance.get.description
CreditBalance returns the number of credits available to this API key.

# paths./balance.get.parameters[].description
The authorization token.  The token will be in the format "Bearer API_KEY".  For example:  "Authorization: Bearer 123456789".  Please include the space between "Bearer" and "API_KEY". 

# paths./balance.get.responses.200.description
Returns the number of credits available to through these two fields:
* CreditsAvailable:  The number of credits available for sending SMS messages through this API.
* CreditsReserved:  Credits held "in reserved" to be used for other TouchBasePro API calls.

# paths./balance.get.responses.400.description
The submitted request was improperly formatted. Please verify the request and try again.

# paths./balance.get.responses.403.description
There is not enough credits on your account or your account has been suspended. Please check with your account representative for more information.

# paths./balance.get.responses.429.description
The number of API calls has been exceeded.  The return will include the number of seconds (represented by (number of seconds) in the example)  until the API call can be tried again.

# paths./balance.get.responses.429.content.application/json.example.message
Rate limit is exceeded.  Try again in {number of seconds} seconds.

# paths./lists.post.description
This method creates new SMS subscriber list.

# paths./lists.post.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists.post.requestBody.description
New list request should contain a JSON object with list name as the only property.

# paths./lists.post.responses.201.description
New SMS subscriber list has been created. Response body contains new record, and Location header contains its url

# paths./lists.post.responses.400.description
An error occurred while making list create request. Please check response body to find additional details about error.

# paths./lists.post.responses.401.description
Provided API credentials is not valid. Please check out response body for more details

# paths./lists.get.description
This method returns SMS subscriber lists for client account.

# paths./lists.get.parameters[].description
The results page to retrieve. It has to be a positive integer.

# paths./lists.get.parameters[].description
The number of records to retrieve per results page. Should be an integer value between 10 and 1000.

# paths./lists.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists.get.responses.400.description
Response returned in case of malformed request or data conflict.

# paths./lists.get.responses.401.description
Provided authorization key is not valid. Please check out response body for additional details.

# paths./lists/{listId}.get.description
This method returns detailed information about requested SMS subscriber list.

# paths./lists/{listId}.get.parameters[].description
ID value of the list details are fetched for

# paths./lists/{listId}.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}.get.responses.200.description
Detailed information about requested SMS subscriber list

# paths./lists/{listId}.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details

# paths./lists/{listId}.get.responses.404.description
Requested SMS subscriber list does not exist

# paths./lists/{listId}.get.responses.404.content.application/json.example.Message
SMS list with provided ID value does not exist

# paths./lists/{listId}.put.description
This method updates SMS subscriber list data

# paths./lists/{listId}.put.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}.put.requestBody.description
SMS subscriber list record is to contain new list name as well as list ID value (need to match the value in Url)

# paths./lists/{listId}.put.responses.200.description
SMS subscriber list was is successfully updated. Updated list data is returned in response body

# paths./lists/{listId}.put.responses.400.description
An error occurred while making list update request. Please check response body to find additional details about error.

# paths./lists/{listId}.put.responses.401.description
Provided authorization key is not valid. Please check out response body for additional details.

# paths./lists/{listId}.put.responses.404.description
SMS list to update does not exist. See response body for additional details.

# paths./lists/{listId}.put.responses.404.content.application/json.example.Message
SMS list with provided ID value does not exist

# paths./list/{listId}.delete.description
This method removes SMS subscriber list, along with associated subscriber records.

# paths./list/{listId}.delete.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./list/{listId}.delete.responses.204.description
Specified SMS list was successfully deleted

# paths./list/{listId}.delete.responses.401.description
Provided API key is not valid. Please check out response body for additional details

# paths./list/{listId}.delete.responses.403.description
Not allowed to delete specified list. Please check out response body for details.

# paths./list/{listId}.delete.responses.403.content.application/json.example.Message
SMS list is referenced by previously scheduled campaign - please unschedule campaign in question before deleting list

# paths./list/{listId}.delete.responses.404.description
SMS list to update does not exist. See response body for additional details.

# paths./list/{listId}.delete.responses.404.content.application/json.example.Message
SMS list with provided ID value does not exist

# paths./lists/{listId}/subscribers.get.description
This method returns SMS subscriber records, that belong to list with specified ID value

# paths./lists/{listId}/subscribers.get.parameters[].description
ID value of SMS list subscribers are to be fetched for

# paths./lists/{listId}/subscribers.get.parameters[].description
The results page to retrieve. It has to be a positive integer.

# paths./lists/{listId}/subscribers.get.parameters[].description
The number of records to retrieve per results page. Should be an integer value between 10 and 1000.

# paths./lists/{listId}/subscribers.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/subscribers.get.responses.200.description
SMS subscriber records that belong to specified list

# paths./lists/{listId}/subscribers.get.responses.400.description
An error occurred while making get subscribers request. Please check response body to find additional details about error.

# paths./lists/{listId}/subscribers.get.responses.400.content.application/json.example.Message
Records page number must be a positive integer value

# paths./lists/{listId}/subscribers.get.responses.401.description
Provided API key is not valid. Please check out response body for additional details.

# paths./lists/{listId}/subscribers.get.responses.404.description
SMS subscriber list with specified ID value does not exist. Please check out response body for additional details.

# paths./lists/{listId}/subscribers.get.responses.404.content.application/json.example.Message
SMS list with provided ID value does not exist

# paths./lists/{listId}/subscribers.post.description
This method creates new SMS subscriber record.

# paths./lists/{listId}/subscribers.post.parameters[].description
ID value of the list subscriber belongs to.

# paths./lists/{listId}/subscribers.post.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/subscribers.post.responses.201.description
SMS subscriber record is successfully created, and returned in response body

# paths./lists/{listId}/subscribers.post.responses.401.description
Provided API credentials is not valid. Please check out response body for more details.

# paths./lists/{listId}/subscribers.post.responses.404.description
SMS subscriber list with specified ID value does not exist.

# paths./lists/{listId}/subscribers.post.responses.404.content.application/json.example.Message
SMS list with provided ID value does not exist

# paths./lists/{listId}/subscribers/{number}.get.description
This method returns detailed information about requested SMS subscriber.

# paths./lists/{listId}/subscribers/{number}.get.parameters[].description
ID value of the list subscriber belongs to.

# paths./lists/{listId}/subscribers/{number}.get.parameters[].description
Mobile phone number of subscriber details are to be fetched for

# paths./lists/{listId}/subscribers/{number}.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/subscribers/{number}.get.responses.200.description
Detailed information about SMS subscriber

# paths./lists/{listId}/subscribers/{number}.get.responses.401.description
Provided authorization key is not valid. Please check out response body for additional details.

# paths./lists/{listId}/subscribers/{number}.get.responses.404.description
Requested subscriber does not exist. Please check out response body for additional details

# paths./lists/{listId}/subscribers/{number}.put.description
This method updates SMS subscriber record.

# paths./lists/{listId}/subscribers/{number}.put.parameters[].description
ID value of the list subscriber to update belongs to

# paths./lists/{listId}/subscribers/{number}.put.parameters[].description
Existing SMS subscriber mobile phone number

# paths./lists/{listId}/subscribers/{number}.put.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/subscribers/{number}.put.requestBody.description
Subscriber data to update - new mobile phone number.

# paths./lists/{listId}/subscribers/{number}.put.responses.200.description
SMS subscriber record is successfully updated. Response body contains updated subscriber record data.

# paths./lists/{listId}/subscribers/{number}.put.responses.400.description
An error occurred while making subscriber update request. Please check response body to find additional details about error.

# paths./lists/{listId}/subscribers/{number}.put.responses.401.description
Provided authorization key is not valid. Please check out response body for additional details.

# paths./lists/{listId}/subscribers/{number}.put.responses.404.description
SMS subscriber record to update does not exist. Please check out response body for additional details

# paths./lists/{listId}/subscribers/{number}.delete.description
This method removes SMS subscriber record from the list.

# paths./lists/{listId}/subscribers/{number}.delete.parameters[].description
ID value of the list subscriber to remove belongs to

# paths./lists/{listId}/subscribers/{number}.delete.parameters[].description
Mobile phone number of subscriber to remove

# paths./lists/{listId}/subscribers/{number}.delete.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/subscribers/{number}.delete.responses.204.description
SMS subscriber record is successfully deleted

# paths./lists/{listId}/subscribers/{number}.delete.responses.400.description
An error occurred while making subscriber remove request. Please check response body to find additional details about error.

# paths./lists/{listId}/subscribers/{number}.delete.responses.401.description
Provided authorization key is not valid. Please check out response body for additional details.

# paths./lists/{listId}/subscribers/{number}.delete.responses.404.description
SMS subscriber record to remove does not exist. See response body for additional details.

# paths./lists/{listId}/subscribers/import.post.description
This method creates one or more SMS subscriber records in a single API call.

# paths./lists/{listId}/subscribers/import.post.parameters[].description
ID value of the list to import SMS subscribers to

# paths./lists/{listId}/subscribers/import.post.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./lists/{listId}/subscribers/import.post.requestBody.description
Request is an array of SMS subscriber obhects (containing phone numbers).

# paths./lists/{listId}/subscribers/import.post.responses.201.description
One or more SMS subscribers were added to designated subscriber list. If some of those subscriber records already existed in the list, they're skipped. Only non-existing ones get added to subscriber list (no duplicates allowed). Response contains thew list of all the records that were added.

# paths./lists/{listId}/subscribers/import.post.responses.400.description
An error occurred while importing SMS subscriber data. Please check response body to find additional details about error.

# paths./lists/{listId}/subscribers/import.post.responses.401.description
Provided authorization key is not valid. Please check out response body for additional details.

# paths./message/forward.get.description
Use this method to get single SMS reply forward details. If previously set, it will return mobile phone number (to which SMS replies will be forwarded) as well as date when it was set.

# paths./message/forward.get.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./message/forward.get.responses.401.description
Provided API credentials is not valid. Please check out response body for more details

# paths./message/forward.post.description
Use this method to get single SMS reply forward details (mobile phone number to which received replies are to be forwarded). In order to clear (remove) previously set mobile phone number, please use an empty string for phone number.

# paths./message/forward.post.parameters[].description
The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

# paths./message/forward.post.requestBody.description
Mobile phone number to which replies are to be forwarded

# paths./message/forward.post.responses.200.description
Single SMS reply forwarding details that got created

# paths./message/forward.post.responses.401.description
Provided API credentials is not valid. Please check out response body for more details

# components.schemas.Message.properties.to.description
One or more mobile numbers message is to be delivered to (comma separated list). Numbers should be in international format (begin with '+' character)

# components.schemas.SendMessageResult.properties.messages.items.properties.accepted.description
Indicator whether or not message was accepted

# components.schemas.CreditBalance.properties.CreditCount.description
Number of SMS credits available on your account

# components.schemas.SmsListGetResponse.properties.Data.items.properties.Id.description
List ID value. Used when fetching list subscribers, updating or deleting list.

# components.schemas.SmsListGetResponse.properties.PageSize.description
Current max. number of records to retrieve

# components.schemas.SmsListGetResponse.properties.TotalPages.description
Total number of (result) pages available

# components.schemas.SmsListCreateRequest.properties.Name.description
SMS subscriber list name. Shouldn't be longer then 250 characters

# components.schemas.SMSListCreateResponse.properties.Id.description
List ID value, to use when manipulating list subscribers, update or delete the list

# components.schemas.SMSListDetailsResponse.properties.SubscriberCount.description
Total SMS subscriber count for the specified list

# components.schemas.SMSSubscribersResponse.properties.Data.description
An array of SMS subscriber records retrieved

# components.schemas.SMSSubscribersResponse.properties.PageSize.description
Subscriber page size (max. number of records returned)

# components.schemas.SMSSubscribersResponse.properties.TotalPages.description
Total number of subscriber pages available to fetch

# components.schemas.SMSSubscribersResponse.properties.TotalRecordCount.description
Total number of SMS subscribers in the list

# components.schemas.GetCampaignsResponse.properties.Data.items.properties.CampaignId.description
SMS Campaign ID value. Use it to fetch campaign details or make other API calls

# components.schemas.GetCampaignsResponse.properties.Data.description
An array with actual SMS Campaign records

# components.schemas.GetCampaignsResponse.properties.TotalRecordCount.description
Total number of SMS Campaigns in client account

# components.schemas.SMSCampaignDetails.properties.RepliesToEmail.description
Email address to which SMS replies are to be forwarded to

# components.schemas.SMSCampaignDetails.properties.RepliesToMobile.description
Mobile phone number to which SMS replies are to be forwarded to

# components.schemas.GetWebhooks.items.properties.IsActive.description
Webhook active status indicator. Notifications are only sent for active webhooks

# components.schemas.GetWebhooks.items.properties.Url.description
Destination URL to which event notifications are to be sent

# components.schemas.SmsWebhookDetails.properties.Note.description
If webhook gets deactivated, this field will contain the reason why it happened

# components.schemas.SmsWebhookDetails.properties.IsActive.description
Webhook active status indicator. Event notifications are only sent to active webhooks

# components.schemas.CreateWebhookRequest.properties.Url.description
Webhook url - an internet address to which event notifications are to be set to

# components.schemas.Webhook.properties.Url.description
Webhook url - address to which event notifications are to be sent

# components.schemas.UpdateWebhook.properties.Url.description
Webhook Url - internet address to which event notifications are to be sent to

# components.schemas.SMSCampaignReport.properties.TotalDelivered.description
Number of recipients that successfully received campaign message

# components.schemas.SMSCampaignReport.properties.TotalBounced.description
Number of recipients that failed to receive campaign message

# components.schemas.SMSCampaignReport.properties.TotalUnsubscribed.description
Number of recipients that have unsubscribed from one or more lists

# components.schemas.SMSCampaignReport.properties.Recipients.description
A list of campaign recipient phone numbers

# components.schemas.SMSCampaignReport.properties.Delivered.items.description
Object containing phone number and the date event took place

# components.schemas.SMSCampaignReport.properties.Bounced.items.properties.Date.description
Date and time message got flagged as undeliverable

# components.schemas.SMSCampaignReport.properties.Bounced.items.description
Object containing phone number and the date event took place

# components.schemas.SMSCampaignReport.properties.Replies.items.description
Object containing phone number, message received and the date event took place

# components.schemas.SMSCampaignReport.properties.Unsubscribed.items.description
Object containing phone number and the date event took place

# components.schemas.SendSmsRequest.properties.Id.description
User assigned (external) message ID value

# components.schemas.SMSInfo.properties.Date.description
Date the last status update has happened

# components.schemas.SMSInfo.properties.MessageId.description
A unique message identifier. Use when checking for message status change

# components.schemas.SMSInfo.properties.MessageSize.description
Number of fragments message was split into (if larger then 160 characters). Also equal to number of credits spent/required for sending

# components.schemas.SMSInfo.properties.Status.description
Current message status: 'Accepted' if message was about to be sent, or 'Rejected' if there were insufficient credits on your account

# components.schemas.SMSInfo.properties.RemainingCreditCount.description
Number of SMS credits left on your account

# components.schemas.SMSInfo.properties.Id.description
External, user assigned message ID value (if present)

# components.schemas.SmsDetails.properties.Id.description
External, user assigned message ID value (if present)

# components.schemas.SmsDetails.properties.Date.description
Date and time when message received current status. Time in UTC