VelozMail | Custom Field

Reserve Fields List

To get Reserve Fields 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/reserve-fields

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/reserve-fields',
  'headers': {
    'PublicKey': 'YOUR_PUBLIC_KEY',
    'SecretKey': 'YOUR_SECRET_KEY'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);

});

123456789101112131415 16 17181920212223242526


import requests

url = "BASE_URL/reserve-fields"

payload={}
headers = {
  'PublicKey': 'YOUR_PUBLIC_KEY',
  'SecretKey': 'YOUR_SECRET_KEY'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

123456789101112131415 1617181920212223242526


?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'BASE_URL/reserve-fields',
  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;

123456789101112131415 1617181920212223242526


curl --location --request GET 'BASE_URL/reserve-fields' \
--header 'PublicKey: YOUR_PUBLIC_KEY' \
--header 'SecretKey: YOUR_SECRET_KEY'

123456789101112131415 1617181920212223242526


require "uri"
require "net/http"

url = URI("BASE_URL/reserve-fields")

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

123456789101112131415 1617181920212223242526


{
    "status": "success",
    "message": {
        "reservedFields": [
            {
                "id": 1,
                "user_id": null,
                "field_name": "first_name",
                "field_type": "text",
                "is_reserved": 1,
                "created_at": null,
                "updated_at": null
            },
            {
                "id": 2,
                "user_id": null,
                "field_name": "last_name",
                "field_type": "text",
                "is_reserved": 1,
                "created_at": null,
                "updated_at": null
            },
        ]
    }
}

123456789101112131415 1617181920212223242526

                                                                
{
    "status": "failed",
    "errors": {
        "PublicKey": [
            "The public key field is required."
        ],
        "SecretKey": [
            "The secret key field is required."
        ]
    }
}

1234567891011121314

Custom Fields List

To get custom fields 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/custom-fields

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/custom-fields',
  'headers': {
    'PublicKey': 'YOUR_PUBLIC_KEY',
    'SecretKey': 'YOUR_SECRET_KEY'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);

});

123456789101112131415 16 17181920212223242526


import requests

url = "BASE_URL/custom-fields"

payload={}
headers = {
  'PublicKey': 'YOUR_PUBLIC_KEY',
  'SecretKey': 'YOUR_SECRET_KEY'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

123456789101112131415 1617181920212223242526


?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'BASE_URL/custom-fields',
  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;

123456789101112131415 1617181920212223242526


curl --location --request GET 'BASE_URL/custom-fields' \
--header 'PublicKey: YOUR_PUBLIC_KEY' \
--header 'SecretKey: YOUR_SECRET_KEY'

123456789101112131415 1617181920212223242526


require "uri"
require "net/http"

url = URI("BASE_URL/custom-fields")

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

123456789101112131415 1617181920212223242526


{
    "status": "success",
    "message": {
        "customFields": [
            {
                "id": 22,
                "user_id": 6790,
                "field_name": "birth_date",
                "field_type": "datetime-local",
                "is_reserved": 0,
                "created_at": "2023-12-05T04:38:36.000000Z",
                "updated_at": "2023-12-05T04:38:36.000000Z"
            },
            {
                "id": 21,
                "user_id": 6790,
                "field_name": "company_name",
                "field_type": "text",
                "is_reserved": 0,
                "created_at": "2023-12-05T04:31:42.000000Z",
                "updated_at": "2023-12-05T04:31:42.000000Z"
            },
        ]
    }
}

123456789101112131415 1617181920212223242526

                                                                
{
    "status": "failed",
    "errors": {
        "PublicKey": [
            "The public key field is required."
        ],
        "SecretKey": [
            "The secret key field is required."
        ]
    }
}

1234567891011121314

Custom Field Create

To create custom field 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/custom-fields/save

API Key: Get YOUR_PUBLIC_KEY and YOUR_SECRET_KEY from the account page

Response format: JSON

Body Params

field_name* string

Only alphanumeric characters (letters A-Z, numbers 0-9) and underscores are allowed. You cannot use reserved field names

field_type* string

Only allowed value are text,number and datetime-local

                                                                
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'BASE_URL/custom-fields/save',
  'headers': {
    'PublicKey': 'YOUR_PUBLIC_KEY',
    'SecretKey': 'YOUR_SECRET_KEY'
  },
  formData: {
    'field_name': 'join_date',
    'field_type': 'datetime-local'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);

});

123456789101112131415 16 17181920212223242526


import requests

url = "BASE_URL/custom-fields/save"

payload={'field_name': 'join_date',
'field_type': 'datetime-local'}
files=[

]
headers = {
  'PublicKey': 'YOUR_PUBLIC_KEY',
  'SecretKey': 'YOUR_SECRET_KEY'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

123456789101112131415 1617181920212223242526


?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'BASE_URL/custom-fields/save',
  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('field_name' => 'join_date','field_type' => 'datetime-local'),
  CURLOPT_HTTPHEADER => array(
    'PublicKey: YOUR_PUBLIC_KEY',
    'SecretKey: YOUR_SECRET_KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

123456789101112131415 1617181920212223242526


curl --location --request POST 'BASE_URL/custom-fields/save' \
--header 'PublicKey: YOUR_PUBLIC_KEY' \
--header 'SecretKey: YOUR_SECRET_KEY' \
--form 'field_name="join_date"' \
--form 'field_type="datetime-local"'

123456789101112131415 1617181920212223242526


require "uri"
require "net/http"

url = URI("BASE_URL/custom-fields/save")

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 = [['field_name', 'join_date'],['field_type', 'datetime-local']]
request.set_form form_data, 'multipart/form-data'
response = http.request(request)
puts response.read_body

123456789101112131415 1617181920212223242526


{
    "status": "success",
    "message": "Added Successfully"
}

123456789101112131415 1617181920212223242526

                                                                
{
    "status": "failed",
    "errors": {
        "field_name": [
            "The field name field is required."
        ],
        "field_type": [
            "The field type field is required."
        ]
    }
}

1234567891011121314

Custom Field Delete

To delete custom field 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/custom-fields/delete?id={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/custom-fields/delete?id=5',
  'headers': {
    'PublicKey': 'YOUR_PUBLIC_KEY',
    'SecretKey': 'YOUR_SECRET_KEY'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);

});

123456789101112131415 16 17181920212223242526


import requests

url = "BASE_URL/custom-fields/delete?id=5"

payload={}
headers = {
  'PublicKey': 'YOUR_PUBLIC_KEY',
  'SecretKey': 'YOUR_SECRET_KEY'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

123456789101112131415 1617181920212223242526


?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'BASE_URL/custom-fields/delete?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 => 'DELETE',
  CURLOPT_HTTPHEADER => array(
    'PublicKey: YOUR_PUBLIC_KEY',
    'SecretKey: YOUR_SECRET_KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

123456789101112131415 1617181920212223242526


curl --location --request DELETE 'BASE_URL/custom-fields/delete?id=5' \
--header 'PublicKey: YOUR_PUBLIC_KEY' \
--header 'SecretKey: YOUR_SECRET_KEY'

123456789101112131415 1617181920212223242526


require "uri"
require "net/http"

url = URI("BASE_URL/custom-fields/delete?id=5")

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

123456789101112131415 1617181920212223242526


{
    "status": "success",
    "message": "Deleted Successfully"
}

123456789101112131415 1617181920212223242526

                                                                
{
    "status": "failed",
    "errors": "Record Not Found"
}

1234567891011121314

Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequuntur fuga odit excepturi, natus voluptate commodi qui sunt quisquam cupiditate molestiae?

English Português Brasil

Reserve Fields List

Body Params

Custom Fields List

Body Params

Custom Field Create

Body Params

Custom Field Delete

Body Params

Useful Links

Support Links

Subscribe Us