Type List
To get Contact Type List follow the example code and be careful with the parameters.
Base Urlhttps://velozmail.contatofacil.com.br/api/
HTTP Method:
GET
API URL: https://velozmail.contatofacil.com.br/api/contacts-type
API Key:
Get YOUR_PUBLIC_KEY and YOUR_SECRET_KEY from the account page
Response format: JSON
Body Params
var request = require('request');
var options = {
'method': 'GET',
'url': 'BASE_URL/contacts-type',
'headers': {
'PublicKey': 'YOUR_PUBLIC_KEY',
'SecretKey': 'YOUR_SECRET_KEY'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
});
123456789101112
131415
16
17181920212223242526
import requests
url = "BASE_URL/contacts-type"
payload={}
headers = {
'PublicKey': 'YOUR_PUBLIC_KEY',
'SecretKey': 'YOUR_SECRET_KEY'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'BASE_URL/contacts-type',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'PublicKey: YOUR_PUBLIC_KEY',
'SecretKey: YOUR_SECRET_KEY'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
curl --location --request GET 'BASE_URL/contacts-type' \
--header 'PublicKey: YOUR_PUBLIC_KEY' \
--header 'SecretKey: YOUR_SECRET_KEY'
require "uri"
require "net/http"
url = URI("BASE_URL/contacts-type")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["PublicKey"] = "YOUR_PUBLIC_KEY"
request["SecretKey"] = "YOUR_SECRET_KEY"
response = http.request(request)
puts response.read_body
{
"status": "success",
"message": {
"contactTypes": [
{
"id": 3,
"user_id": 6790,
"name": "Friend Lists",
"deleted_at": null,
"created_at": "2023-11-02T09:02:47.000000Z",
"updated_at": "2023-11-02T09:02:47.000000Z",
"contacts_count": 6
},
{
"id": 4,
"user_id": 6790,
"name": "Office Colleague",
"deleted_at": null,
"created_at": "2023-11-02T09:25:11.000000Z",
"updated_at": "2023-11-02T09:25:11.000000Z",
"contacts_count": 1
},
]
}
}
{
"status": "failed",
"errors": {
"PublicKey": [
"The public key field is required."
],
"SecretKey": [
"The secret key field is required."
]
}
}
123456789101112
1314
Type Add
To add contact type follow the example code and be careful with the parameters.
Base Urlhttps://velozmail.contatofacil.com.br/api/
HTTP Method:
POST
API URL: https://velozmail.contatofacil.com.br/api/contacts-type/add
API Key:
Get YOUR_PUBLIC_KEY and YOUR_SECRET_KEY from the account page
Response format: JSON
Body Params
name* string
name should be min character 2
var request = require('request');
var options = {
'method': 'POST',
'url': 'BASE_URL/contacts-type/add',
'headers': {
'PublicKey': 'YOUR_PUBLIC_KEY',
'SecretKey': 'YOUR_SECRET_KEY'
},
formData: {
'name': 'Friend List'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
});
123456789101112
131415
16
17181920212223242526
import requests
url = "BASE_URL/contacts-type/add"
payload={'name': 'Friend List'}
files=[
]
headers = {
'PublicKey': 'YOUR_PUBLIC_KEY',
'SecretKey': 'YOUR_SECRET_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'BASE_URL/contacts-type/add',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('name' => 'Friend List'),
CURLOPT_HTTPHEADER => array(
'PublicKey: YOUR_PUBLIC_KEY',
'SecretKey: YOUR_SECRET_KEY'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
curl --location --request POST 'BASE_URL/contacts-type/add' \
--header 'PublicKey: YOUR_PUBLIC_KEY' \
--header 'SecretKey: YOUR_SECRET_KEY' \
--form 'name="Friend List"'
require "uri"
require "net/http"
url = URI("BASE_URL/contacts-type/add")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["PublicKey"] = "YOUR_PUBLIC_KEY"
request["SecretKey"] = "YOUR_SECRET_KEY"
form_data = [['name', 'Friend List']]
request.set_form form_data, 'multipart/form-data'
response = http.request(request)
puts response.read_body
{
"status": "success",
"message": "Added Successfully"
}
{
"status": "failed",
"errors": {
"name": [
"The name field is required."
]
}
}
123456789101112
1314
Type View
To view details contact type follow the example code and be careful with the parameters.
Base Urlhttps://velozmail.contatofacil.com.br/api/
HTTP Method:
GET
API URL: https://velozmail.contatofacil.com.br/api/ contacts-type/view?contact_type_id={contact_type_id}
API Key:
Get YOUR_PUBLIC_KEY and YOUR_SECRET_KEY from the account page
Response format: JSON
Body Params
var request = require('request');
var options = {
'method': 'GET',
'url': 'BASE_URL/contacts-type/view?contact_type_id=5',
'headers': {
'PublicKey': 'YOUR_PUBLIC_KEY',
'SecretKey': 'YOUR_SECRET_KEY'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
});
});
123456789101112
131415
16
17181920212223242526
import requests
url = "BASE_URL/contacts-type/view?contact_type_id=5"
payload={}
headers = {
'PublicKey': 'YOUR_PUBLIC_KEY',
'SecretKey': 'YOUR_SECRET_KEY'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'BASE_URL/contacts-type/view?contact_type_id=5',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'PublicKey: YOUR_PUBLIC_KEY',
'SecretKey: YOUR_SECRET_KEY'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
curl --location --request GET 'BASE_URL/contacts-type/view?contact_type_id=5' \
--header 'PublicKey: YOUR_PUBLIC_KEY' \
--header 'SecretKey: YOUR_SECRET_KEY'
require "uri"
require "net/http"
url = URI("BASE_URL/contacts-type/view?contact_type_id=5")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["PublicKey"] = "YOUR_PUBLIC_KEY"
request["SecretKey"] = "YOUR_SECRET_KEY"
response = http.request(request)
puts response.read_body
{
"status": "success",
"message": {
"contactType": {
"id": 5,
"user_id": 6790,
"name": "Client List",
"deleted_at": null,
"created_at": "2023-11-08T05:16:49.000000Z",
"updated_at": "2023-11-08T05:16:49.000000Z"
}
}
}
{
"status": "failed",
"errors": {
"field_name": [
"The field name field is required."
],
"field_type": [
"The field type field is required."
]
}
}
123456789101112
1314
Type Update
To contact type follow the example code and be careful with the parameters.
Base Urlhttps://velozmail.contatofacil.com.br/api/
HTTP Method:
POST
API URL: https://velozmail.contatofacil.com.br/api/contacts-type/update
API Key:
Get YOUR_PUBLIC_KEY and YOUR_SECRET_KEY from the account page
Response format: JSON
Body Params
id* integer
This is contact type id
name* string
The name should be min 2 character
var request = require('request');
var options = {
'method': 'POST',
'url': 'BASE_URL/contacts-type/update',
'headers': {
'PublicKey': 'YOUR_PUBLIC_KEY',
'SecretKey': 'YOUR_SECRET_KEY'
},
formData: {
'id': '5',
'name': 'Friend List'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
});
123456789101112
131415
16
17181920212223242526
import requests
url = "BASE_URL/contacts-type/update"
payload={'id': '5',
'name': 'Friend List'}
files=[
]
headers = {
'PublicKey': 'YOUR_PUBLIC_KEY',
'SecretKey': 'YOUR_SECRET_KEY'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'BASE_URL/contacts-type/update',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('id' => '5','name' => 'Friend List'),
CURLOPT_HTTPHEADER => array(
'PublicKey: YOUR_PUBLIC_KEY',
'SecretKey: YOUR_SECRET_KEY'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
curl --location --request POST 'BASE_URL/contacts-type/update' \
--header 'PublicKey: YOUR_PUBLIC_KEY' \
--header 'SecretKey: YOUR_SECRET_KEY' \
--form 'id="5"' \
--form 'name="Friend List"'
require "uri"
require "net/http"
url = URI("BASE_URL/contacts-type/update")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["PublicKey"] = "YOUR_PUBLIC_KEY"
request["SecretKey"] = "YOUR_SECRET_KEY"
form_data = [['id', '5'],['name', 'Friend List']]
request.set_form form_data, 'multipart/form-data'
response = http.request(request)
puts response.read_body
{
"status": "success",
"message": "Updated Successfully"
}
{
"status": "failed",
"errors": "Record Not Found"
}
123456789101112
1314
Type Delete
To delete contact type follow the example code and be careful with the parameters.
Base Urlhttps://velozmail.contatofacil.com.br/api/
HTTP Method:
DELETE
API URL: https://velozmail.contatofacil.com.br/api/ contacts-type/delete?contact_type_id={contact_type_id}
API Key:
Get YOUR_PUBLIC_KEY and YOUR_SECRET_KEY from the account page
Response format: JSON
Body Params
var request = require('request');
var options = {
'method': 'DELETE',
'url': 'BASE_URL/contacts-type/delete?contact_type_id=15',
'headers': {
'PublicKey': 'YOUR_PUBLIC_KEY',
'SecretKey': 'YOUR_SECRET_KEY'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
});
123456789101112
131415
16
17181920212223242526
import requests
url = "BASE_URL/contacts-type/delete?contact_type_id=15"
payload={}
headers = {
'PublicKey': 'YOUR_PUBLIC_KEY',
'SecretKey': 'YOUR_SECRET_KEY'
}
response = requests.request("DELETE", url, headers=headers, data=payload)
print(response.text)
?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'BASE_URL/contacts-type/delete?contact_type_id=15',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'PublicKey: YOUR_PUBLIC_KEY',
'SecretKey: YOUR_SECRET_KEY'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
curl --location --request DELETE 'BASE_URL/contacts-type/delete?contact_type_id=15' \
--header 'PublicKey: YOUR_PUBLIC_KEY' \
--header 'SecretKey: YOUR_SECRET_KEY'
require "uri"
require "net/http"
url = URI("BASE_URL/contacts-type/delete?contact_type_id=15")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Delete.new(url)
request["PublicKey"] = "YOUR_PUBLIC_KEY"
request["SecretKey"] = "YOUR_SECRET_KEY"
response = http.request(request)
puts response.read_body
{
"status": "success",
"errors": "Deleted Successfully"
}
{
"status": "failed",
"errors": "Record Not Found"
}
123456789101112
1314
Copyright ©2024 VelozMail All Rights Reserved