Add contact
API URL
URL used to send HTTP requests:
https://portal.bulkgate.com/api/1.0/address-book/add
POST /api/1.0/address-book/add HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache
Parameters table
PARAMETER NAME | VALUE | MANDATORY | DEFAULT VALUE |
---|---|---|---|
application_id | Application ID | Yes | - |
application_token | Application token | Yes | - |
groups | Array of group ID's in which contacts will be added | No | - |
group_name | Added contact will be added to new group with name group_name | No | - |
data | Contact information | Yes | Data object |
Data object
PARAMETER NAME | VALUE | MANDATORY | DEFAULT VALUE |
---|---|---|---|
type | Type of contact (person/company) | No | - |
phone_mobile | Main phone number | No | - |
phone | Secondary phone number | No | - |
title_before | Title before name | No | - |
first_name | First name | No | - |
last_name | Last name | No | - |
title_after | Title after name | No | - |
gender | Gender (male/female/unknown) | No | unknown |
company_name | Name of your company | No | - |
No | - | ||
url | Url of your website | No | - |
street1 | 1. Street address | No | - |
street2 | 2. Street address | No | - |
city | City | No | - |
zip | Zip code | No | - |
state | State | No | - |
country | Country code in ISO 3166-1 alpha-2 format | No | null |
company_number | Company number | No | - |
company_vat | Company vat | No | - |
note | Note | No | - |
custom_field_0 | Custom field | No | - |
custom_field_1 | Custom field | No | - |
custom_field_2 | Custom field | No | - |
custom_field_3 | Custom field | No | - |
custom_field_4 | Custom field | No | - |
custom_field_5 | Custom field | No | - |
custom_field_6 | Custom field | No | - |
custom_field_7 | Custom field | No | - |
custom_field_8 | Custom field | No | - |
custom_field_9 | Custom field | No | - |
Example of full request
POST /api/1.0/address-book/add HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache
{
"application_id": "####",
"application_token": "##################################################",
"groups": [1, 2],
"group_name": "Talos 1",
"data": {
"first_name": "Morgan",
"last_name": "Yu",
"phone_mobile": "123456789",
"street1": "Crew's quarters",
"street2": "Executive suite",
"country": "Talos 1",
"email": "morganyu@talos.com"
}
}
Response to this command may be:
In case of success:
{
"data": {
"message": "contact_has_been_added",
"groups": [1,2,3]
}
}
In case of error:
{
"type": "contact_with_this_phone_number_already_exists",
"code": 400,
"error": "Contact with this phone number already exists",
"detail": null
}
{
"type": "invalid_phone_mobile",
"code": 400,
"error": "Invalid phone mobile",
"detail": null
}
{
"type": "group_not_found",
"code": 400,
"error": "Group not found",
"detail": null
}