Top-up Customer Email Quota

You can use this API request to top-up a customer's email quota.

The Method

API Method
RESTPOSThttp://[Your URL/api/2.0/customers/topup/:id/:package_identifier
Your URL is the address of your Everlytic install.

Your method must be structured as follows:

Topup(integer $id, string $package_identifier)


Required Parameters

You must include the following parameters for the request to work:

$idintegerID of the customer to top-up.noneyes
$package_idstringIdentifier for the top-up package.noneyes


ObjectThe updated customer object.

Code Samples


The rest of this document describes the example above, step-by-step.

In our Getting Started section we covered the four important components of an API request; URL, method, headers, and body.


Let's analyse the code sample above to determine where each line fits into this outline.

1. Specify the customer and package for the server to change

$customer_id = 1;

$package_identifier = 2;

2. Load the Everlytic API

The following line of code tells the server which API URL to access for the request:

$url = '(Your URL)/api/2.0/customers/topup/' . $customer_id . '/' . $package_identifier;

Your URL is the URL of your Everlytic installation.

3. Method

In this line of code, you tell the API which REST function to use:

$method = 'PUT';

4. cURL

cURL is a tool for sending and receiving files from a web server. This line of code initialises the cURL session.

$cSession = curl_init();

5. Initiate the Headers

This section of the code opens the headers section and passes the authentication (including your API key).

$headers = array();

$auth = base64_encode($username . ':' .

$apikey); $headers[] = 'Authorization: Basic ' . $auth;

6. Set various cURL options for the session

These lines of code tell the server that we're using cURL to transfer data.

curl_setopt($cSession, CURLOPT_URL, $url);

curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);

curl_setopt($cSession, CURLOPT_HEADER, false);

curl_setopt($cSession, CURLOPT_CUSTOMREQUEST,


curl_setopt($cSession, CURLOPT_POSTFIELDS, $json);

7. Tell the server to read the variables from the JSON string

$headers[] = 'Content-Type: application/json';

curl_setopt($cSession, CURLOPT_HTTPHEADER, $headers);

8. Output the API response

$result = curl_exec($cSession);

9. Close the cURL session


Translate »