Importer des contacts

URL de l'API

URL utilisée pour l'envoi des requêtes HTTP :

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

Note

Si la requête n'atteint pas sa destination, renvoyez-la sur le serveur de secours backup1.bulkgate.com.

Méthodes HTTP prises en charge

POST - application/json

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

Tableau des paramètres

NOM DU PARAMÈTRE	VALEUR	OBLIGATOIRE	VALEUR PAR DÉFAUT
application_id	ID d'application	Oui	-
application_token	Jeton d'application	Oui	-
groups	Tableau des ID de groupes auxquels les contacts seront ajoutés	Non	-
group_name	Les contacts importés seront ajoutés à un nouveau groupe portant ce nom	Non	-
data	Informations sur les contacts	Oui	Tableau d'objets Data
category	Carnet d'adresses à utiliser. Par défaut, le carnet principal du compte.	Non	`main`
duplicity_action	Que faire d'un contact déjà présent — `restrict` (refuser), `skip` (ignorer), `update` (compléter les champs vides), `rewrite` (écraser).	Non	`skip`

Objet Data

NOM DU PARAMÈTRE	VALEUR	OBLIGATOIRE	VALEUR PAR DÉFAUT
type	Type de contact (personne/entreprise)	Non	-
phone_mobile	Numéro de téléphone principal	Non	-
title_before	Titre avant le nom	Non	-
first_name	Prénom	Non	-
last_name	Nom	Non	-
title_after	Titre après le nom	Non	-
gender	male / female / transgender / agender / non_binary / unknown	Non	unknown
company_name	Nom de votre entreprise	Non	-
email	E-mail	Non	-
url	URL de votre site web	Non	-
street1	Adresse, ligne 1	Non	-
street2	Adresse, ligne 2	Non	-
city	Ville	Non	-
zip	Code postal	Non	-
state	État / région	Non	-
country	Code pays au format ISO 3166-1 alpha-2	Non	`null`
company_number	Numéro d'identification de l'entreprise	Non	-
company_vat	Numéro de TVA de l'entreprise	Non	-
note	Note	Non	-
custom_field_0	Champ personnalisé	Non	-
custom_field_1	Champ personnalisé	Non	-
custom_field_2	Champ personnalisé	Non	-
custom_field_3	Champ personnalisé	Non	-
custom_field_4	Champ personnalisé	Non	-
custom_field_5	Champ personnalisé	Non	-
custom_field_6	Champ personnalisé	Non	-
custom_field_7	Champ personnalisé	Non	-
custom_field_8	Champ personnalisé	Non	-
custom_field_9	Champ personnalisé	Non	-

Exemple de requête

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

Réponse

En cas de succès :

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

En cas d'erreur :

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

Où :

type et error (description de l'erreur) sont décrits dans le tableau des types d'erreurs
code représente le code d'erreur HTTP
detail contient des informations complémentaires sur l'erreur

Cette page vous a-t-elle été utile ?

Demander à l'IA Copié