Get updates

View all updates


Method URI

Request Parameters

Parameter Type Description Required
HTTP headers: Authorization string Bearer + the token to access APIs Required
limitstart integer The offset for the returned announcement data (default: 0) Optional
limitnum integer The number of records to return (default: 25) Optional

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
totalresults integer The total number of results available
startnumber integer The starting number for the returned results
numreturned integer The number of results returned
announcements array The announcement entries returned

Example Request (PHP Curl)


                    $curl = curl_init();
                    curl_setopt_array($curl, array(
                      CURLOPT_URL => "",
                      CURLOPT_RETURNTRANSFER => true,
                      CURLOPT_ENCODING => "",
                      CURLOPT_MAXREDIRS => 10,
                      CURLOPT_TIMEOUT => 0,
                      CURLOPT_FOLLOWLOCATION => false,
                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                      CURLOPT_CUSTOMREQUEST => "POST",
                      CURLOPT_POSTFIELDS =>
                      CURLOPT_HTTPHEADER => array(
                        "Content-Type: multipart/form-data",
                        "X-Requested-With: XMLHttpRequest",
                        "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
                    $response = curl_exec($curl);
                    $err = curl_error($curl);
                    if ($err) {
                      echo "cURL Error #:" . $err;
                    } else {
                      echo $response;


Example Request (jQuery AJAX)

                    var form = new FormData();

                    var settings = {
                        "async": true,
                        "crossDomain": true,
                        "url": "",
                        "method": "POST",
                        "headers": {
                            "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNjMDEwYWVlYmUzMjMxMmZlZjBiNzRjYTBhMmNlNDc2MjNjNhMMTA1MzJjODk1In0",
                            "cache-control": "no-cache",
                        "processData": false,
                        "contentType": false,
                        "mimeType": "multipart/form-data",
                        "data": form

                    $.ajax(settings).done(function (response) {

Example Response (JSON payload)

                    "result"                                      : "success",
                    "totalresults"                                : "1",
                    "startnumber"                                 : "0",
                    "numreturned"                                 : "1",
                    "announcements[announcement][0][id]"          : "1",
                    "announcements[announcement][0][date]"        : "2016-02-24 21:27:04",
                    "announcements[announcement][0][title]"       : "Thank you for choosing WHMCS!",
                    "announcements[announcement][0][announcement]": "<p>Welcome to <a title=\"WHMCS\" href=\"https:\/\/\" target=\"_blank\">WHMCS<\/a>! You have made a great choice and we want to help you get up and running as quickly as possible.<\/p><p>This is a sample announcement. Announcements are a great way to keep your customers informed about news and special offers. You can edit or delete this announcement by logging into the admin area and navigating to <em>Support > Announcements<\/em>.<\/p><p>If at any point you get stuck, our support team is available 24x7 to assist you. Simply visit <a title=\"\/support\" href=\"https:\/\/\/support\" target=\"_blank\">\/support<\/a> to request assistance.<\/p>",
                    "announcements[announcement][0][published]"   : "1",
                    "announcements[announcement][0][parentid]"    : "0",
                    "announcements[announcement][0][language]"    : "",
                    "announcements[announcement][0][created_at]"  : "0000-00-00 00:00:00",
                    "announcements[announcement][0][updated_at]"  : "0000-00-00 00:00:00"