Nič sa nenašlo

Importovať kontakty

API URL

Adresa URL používaná na odosielanie HTTP požiadaviek:

https://portal.bulkgate.com/api/1.0/address-book/import
Poznámka

Ak sa požiadavka nedostane k cieľu, zopakujte ju na záložnom serveri backup1.bulkgate.com.

Podporované HTTP metódy

  • POST - application/json
POST /api/1.0/address-book/import HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Tabuľka s parametrami

NÁZOV PARAMETRA HODNOTA POVINNÝ PREDVOLENÁ HODNOTA
application_id Aplikačný identifikátor Áno -
application_token Aplikačný overovací token Áno -
groups Pole ID skupín, do ktorých sa kontakty pridajú Nie -
group_name Importované kontakty sa pridajú do skupiny s názvom group_name Nie -
data Kontaktné informácie Áno Pole Data objektov
category Adresár, s ktorým sa pracuje. Predvolený je hlavný adresár účtu. Nie main
duplicity_action Čo robiť s kontaktom, ktorý už v adresári je — restrict (odmietnuť), skip (preskočiť), update (doplniť prázdne polia), rewrite (prepísať). Nie skip

Data objekt

NÁZOV PARAMETRA HODNOTA POVINNÝ PREDVOLENÁ HODNOTA
type Typ kontaktu (person/company) Nie -
phone_mobile Hlavné telefónne číslo Áno -
title_before Titul pred menom Nie -
first_name Krstné meno Nie -
last_name Priezvisko Nie -
title_after Titul za menom Nie -
gender male / female / transgender / agender / non_binary / unknown Nie unknown
company_name Názov spoločnosti Nie -
email E-mail Nie -
url URL vašej webovej stránky Nie -
street1 Ulica – 1. riadok Nie -
street2 Ulica – 2. riadok Nie -
city Mesto Nie -
zip PSČ Nie -
state Štát Nie -
country Kód krajiny vo formáte ISO 3166-1 alpha-2 Nie null
company_number IČO Nie -
company_vat DIČ Nie -
note Poznámka Nie -
custom_field_0 Voliteľné pole Nie -
custom_field_1 Voliteľné pole Nie -
custom_field_2 Voliteľné pole Nie -
custom_field_3 Voliteľné pole Nie -
custom_field_4 Voliteľné pole Nie -
custom_field_5 Voliteľné pole Nie -
custom_field_6 Voliteľné pole Nie -
custom_field_7 Voliteľné pole Nie -
custom_field_8 Voliteľné pole Nie -
custom_field_9 Voliteľné pole Nie -

Príklad požiadavky

POST /api/1.0/address-book/import HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "groups": [1, 2], "group_name": "Talos 1", "data": [ { "first_name": "Morgan", "last_name": "Yu", "phone_mobile": "789456123" }, { "first_name": "Alex", "last_name": "Yu", "phone_mobile": "123456789" } ] }

Odpoveď

V prípade úspechu:

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

V prípade chyby:

{ "type": "no_valid_contacts_found", "code": 400, "error": "No valid contacts found", "detail": null }

Kde:

  • type a error (popis chyby) nájdete v tabuľke typov chýb
  • code je HTTP kód chyby
  • detail je doplňujúca informácia o chybe
Bola táto stránka užitočná?