Send Welcome Mail

You can use this method to send a welcome mail to a new user.

The Method

API Method
RESTPOSThttp://[Your URL]/api/2.0/send_welcome_email/:welcome_user_id
Your URL is the address of your Everlytic install.

Your method must be structured as follows:

SendAuthenticationEmail($welcome_user_id) : int


Required Parameters

For this call to work, you must specify the ID of the user to send the welcome email to.

PropertyTypeDescriptionDefaultRequiredRead Only
$welcome_user_idintegerThe ID of the user who will be sent a welcome email.emptyyesno


stringWhether the call succeeded or failed.

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 your user details

<p$user = '(username)';

$apiKey = '(Your API Key)';

2. Load the Everlytic API

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

$host = 'http://(Your URL)';

$path = '/api/2.0/send_welcome_email;

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 = 'POST';

4. Set up the fields for the JSON string

$json = '





5. 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();

6. Initiate the Headers

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

$auth = base64_encode($user . ':' . $apiKey);

$headers = array();

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

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

7. 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_HTTPHEADER, $headers);

curl_setopt($cSession, CURLOPT_URL, $host . $path);

curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);

curl_setopt($cSession, CURLOPT_HEADER, false);

curl_setopt($cSession, CURLOPT_CUSTOMREQUEST,


curl_setopt($cSession, CURLOPT_POSTFIELDS, $json);

8. Output the API response

$result = curl_exec($cSession);

9. Close the cURL session

Translate »