Modifier un contact avec l'API Omnisend

Met à jour un contact. Seuls les champs envoyés changent, mais tags remplace toute la liste de tags : pour seulement ajouter des tags, utilisez Appliquer des tags. Un statut de canal dans identifiers abonne ou désabonne le contact.

Identifiant
omnisend_update_contact

L'appel

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

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

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
idstringOuiID of the contact, from List contacts.
identifiersarrayNonEmail and phone of the contact, each with the subscription status of its channel: email for the email identifier and sms for the phone identifier.
firstNamestringNonFirst name of the contact.
lastNamestringNonLast name of the contact.
tagsarrayNonThe full list of tags the contact keeps. An empty list removes every tag.
customPropertiesobjectNonCustom properties to change, keyed by name, with Latin letters, digits and underscores only. An empty value removes the property.
genderstringNonGender of the contact.Valeurs : m, f
birthdatestringNonBirth date of the contact, as YYYY-MM-DD.
addressstringNonStreet, number and apartment.
citystringNonCity.
statestringNonState as the ISO 3166-2 subdivision code, for example SP.
postalCodestringNonPostal code.
countryCodestringNonCountry as the ISO 3166-1 alpha-2 code, for example BR.

Connexions possibles

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

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

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/omnisend_update_contact. Il devient la définition de tool de votre agent sans conversion.

Autres tools Omnisend

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.