Přidat kontakt

API URL

Adresa URL používaná k odeslání požadavků HTTP:

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

Tabulka s parametry

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
application_id	Aplikační identifikátor	Ano	-
application_token	Aplikační ověřovací token	Ano	-
groups	Pole ID skupin do kterých bude kontakt přidán	Ne	-
group_name	Přidaný kontakt bude přidán do skupiny pod jménem group_name	Ne	-
data	Kontaktní informace	Ano	Data objekt

Data objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	Typ kontaktu (person/company)	Ne	-
phone_mobile	Hlavní telefonní číslo	Ano	-
phone	Sekundární telefonní číslo	Ne	-
title_before	Titul před jménem	Ne	-
first_name	Křestní jméno	Ne	-
last_name	Příjmení	Ne	-
title_after	Titul po jméně	Ne	-
gender	Pohlaví (male/female/unknown)	Ne	unknown
company_name	Jméno společnosti	Ne	-
email	Email	Ne	-
url	Url vaší webové stránky	Ne	-
street1	1. adresa ulice	Ne	-
street2	2. adresa ulice	Ne	-
city	Město	Ne	-
zip	Zip kód	Ne	-
state	Stát	Ne	-
country	Kód země ISO 3166-1 alpha-2 format	Ne	null
company_number	IČO	Ne	-
company_vat	DIČO	Ne	-
note	Poznámka	Ne	-
custom_field_0	Volitelné pole	Ne	-
custom_field_1	Volitelné pole	Ne	-
custom_field_2	Volitelné pole	Ne	-
custom_field_3	Volitelné pole	Ne	-
custom_field_4	Volitelné pole	Ne	-
custom_field_5	Volitelné pole	Ne	-
custom_field_6	Volitelné pole	Ne	-
custom_field_7	Volitelné pole	Ne	-
custom_field_8	Volitelné pole	Ne	-
custom_field_9	Volitelné pole	Ne	-

Příklad úplného požadavku

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"
    }
}

Odpověď na tento příkaz může být:

V případě úspěchu:

{
    "data": {
        "message": "contact_has_been_added",
        "groups": [1,2,3]
    }
}

V případě chyby:

{
    "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
}