Créer un contact avec l'API Keap

Crée un contact et le renvoie. Il faut au moins un élément dans email_addresses, phone_numbers ou addresses. Avec duplicate_option, un contact correspondant est mis à jour au lieu d'en créer un nouveau.

Identifiant
keap_create_contact

L'appel

POST https://connect.reportei.com/api/tools/keap_create_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "given_name": "<given_name>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
given_namestringNonFirst name.
family_namestringNonLast name.
job_titlestringNonJob title.
email_addressesarrayNonEmail addresses, one per slot.
phone_numbersarrayNonPhone numbers, one per slot.
addressesarrayNonPostal addresses, one per kind.
websitestringNonWebsite address.
owner_idstringNonId of the user who owns the contact, the id field of List users (not global_user_id).
contact_typestringNonType of the contact as configured in the Keap app, for example Lead or Customer.
birth_datestringNonBirth date, for example 1990-05-17.
duplicate_optionstringNonMatch used to find an existing contact to update instead of creating one: by email, by email and name, or by email, name and company. Without it, a new contact is always created.Valeurs : Email, EmailAndName, EmailAndNameAndCompany

Connexions possibles

Votre client connecte son compte Keap une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/keap, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/keap_create_contact. Il devient la définition de tool de votre agent sans conversion.

Autres tools Keap

Voir les 14 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.