Změnit kontakt

API URL

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

https://portal.bulkgate.com/api/1.0/address-book/edit

Poznámka

Nedostane-li se požadavek k cíli, zopakujte ho na záložním serveru backup1.bulkgate.com.

Podporované HTTP metody

POST - application/json

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

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	-
phone_number	Telefonní číslo editovaného kontaktu	Ano	-
data	Kontaktní informace	Ano	Data objekt
category	Adresář, se kterým se pracuje. Výchozí je hlavní adresář účtu.	Ne	`main`

Poznámka

Vynechané pole zůstane beze změny — schéma za něj dosadí -do-not-modify-. Chcete-li pole vyprázdnit, pošlete prázdný řetězec.

Data objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	Typ kontaktu (person/company)	Ne	-
phone_mobile	Hlavní 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	male / female / transgender / agender / non_binary / 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 požadavku

POST /api/1.0/address-book/edit HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "phone_number": "123456789", "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ěď

V prípadě úspěchu:

{ "data": { "message": "contact_has_been_edited" } }

V případě chyby:

{ "type": "number_not_found", "code": 400, "error": "Number not found", "detail": null }

{ "type": "invalid_phone_number", "code": 400, "error": "Invalid phone number", "detail": null }

{ "type": "invalid_phone_mobile", "code": 400, "error": "Invalid phone mobile", "detail": null }

Kde:

type a error (popis chyby) najdete v tabulce typů chyb
code je HTTP kód chyby
detail je doplňující informace o chybě

Byla tato stránka užitečná?

Zeptat se AI Zkopírováno