Add contact
Add a contact
Endpoint
Method | URI |
---|---|
POST |
https://apiv2.keliweb.it/api/v2/keliweb/add-contact
|
Request Parameters
Parameter | Type | Description | Required |
---|---|---|---|
HTTP headers:
Authorization
|
string |
Bearer + the token to access APIs
|
Required |
firstname
|
string | Optional | |
lastname
|
string | Optional | |
companyname
|
string | Optional | |
email
|
string | Email address to identify the contact. This should be unique if the contact will be a sub-account | Optional |
address1
|
string | Optional | |
address2
|
string | Optional | |
city
|
string | Optional | |
state
|
string | Optional | |
postcode
|
string | Optional | |
country
|
string | 2 character ISO country code | Optional |
phonenumber
|
string | Optional | |
tax_id
|
string | Optional | |
password2
|
string | if creating a sub-account | Optional |
generalemails
|
boolean | set true to receive general email types | Optional |
productemails
|
boolean | set true to receive product related emails | Optional |
domainemails
|
boolean | set true to receive domain related emails | Optional |
invoiceemails
|
boolean | set true to receive billing related emails | Optional |
supportemails
|
boolean | set true to receive support ticket related emails | Optional |
Response Parameters
Parameter | Type | Description |
---|---|---|
result
|
string | The result of the operation: success or error |
contactid
|
integer | The id of the newly added contact. |
Example Request (PHP Curl)
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://apiv2.keliweb.it/api/v2/keliweb/add-contact",
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 =>
http_build_query(
array(
'clientid' => '1',
'firstname' => 'Jane',
'lastname' => 'Doe',
'email' => 'jane.doe@example.com'
)
),
CURLOPT_HTTPHEADER => array(
"Content-Type: multipart/form-data",
"X-Requested-With: XMLHttpRequest",
"Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Example Request (jQuery AJAX)
var form = new FormData();
form.append("clientid", "1");
form.append("firstname", "Jane");
form.append("lastname", "Doe");
form.append("email", "jane.doe@example.com");
var settings = {
"async": true,
"crossDomain": true,
"url": "https://apiv2.keliweb.it/api/v2/keliweb/add-contact",
"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) {
console.log(response);
});
Example Response (JSON payload)
{
"result" : "success",
"contactid": "1"
}