Mettre à jour le contact

Les développeurs peuvent mettre à jour les informations du contact via l'API.

Méthode de requête

PATCH

URL de requête

https://livedesk-api.engagelab.com/api/v2/accounts/contacts/:id

Authentification

Pour plus de détails, consultez la description de la méthode d'authentification dans la Présentation de l'API.

Requête

Exemple de requête

curl -X PATCH https://livedesk-api.engagelab.com/api/v2/accounts/contacts/:id \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ { "additional_attributes": { "description": "", "company_name": "", "city": "", "telegram": "", "country": "", "country_code": "", "social_profiles": { "facebook": "", "github": "", "instagram": "", "linkedin": "", "twitter": "" } }, "availability_status": "offline", "email": "support@jiguang.cn", "name": "support", "phone_number": null, "blocked": false, "identifier": "2222", "thumbnail": "", "last_activity_at": 1765441908, "custom_attributes": { // Optionnel : fusionner et mettre à jour les champs personnalisés (fusion incrémentale) "vip_level": "platinum" }, "created_at": 1765441895, "first_name": "support", "last_name": "" }

              
              curl -X PATCH https://livedesk-api.engagelab.com/api/v2/accounts/contacts/:id \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
{
    "additional_attributes":
     {
        "description": "",
        "company_name": "",
        "city": "",
        "telegram": "",
        "country": "",
        "country_code": "",
        "social_profiles": 
        {
            "facebook": "",
            "github": "",
            "instagram": "",
            "linkedin": "",
            "twitter": ""
        }
    },
    "availability_status": "offline",
    "email": "support@jiguang.cn",
    "name": "support",
    "phone_number": null,
    "blocked": false,
    "identifier": "2222",
    "thumbnail": "",
    "last_activity_at": 1765441908,
    "custom_attributes": 
    {                  // Optionnel : fusionner et mettre à jour les champs personnalisés (fusion incrémentale)
    "vip_level": "platinum"
    },
    "created_at": 1765441895,
    "first_name": "support",
    "last_name": ""
}

Afficher ce bloc de code dans la fenêtre flottante

En-têtes de requête

Champ	Type	Description
Authorization	string	Utilisez `Authorization: Basic base64(API Key:API Secret)` pour l'authentification. Accédez à la page API Key pour obtenir l'API Key et l'API Secret, reliez-les avec un deux-points, puis encodez le résultat en Base64.
Content-Type	application/json	Il s'agit du format de données de la requête. Utilisez `application/json`.

Paramètres de chemin

Champ	Type	Obligatoire	Description
account	integer	Oui	ID du compte
id	integer	Oui	ID du contact

Paramètres du corps de la requête

Champ	Type	Obligatoire	Description
additional_attributes	Object	Non	Attributs supplémentaires.
description	Object	Non	Informations descriptives.
company_name	String	Non	Nom de l'entreprise.
city	String	Non	Ville.
telegram	String	Non	Contact Telegram.
country	String	Non	Pays.
country_code	String	Non	Indicatif du pays.
social_profiles	String	Non	Coordonnées sur les réseaux sociaux.
availability_status	String	Non	Statut en ligne. La valeur par défaut est `offline`.
email	String	Non	Adresse e-mail.
name	String	Non	Nom.
phone_number	String	Non	Numéro de téléphone.
blocked	String	Non	Indique si le contact est bloqué. La valeur par défaut est `false`.
identifier	String	Non	Identifiant externe unique du contact, correspondant au UserID affiché dans l'interface.
thumbnail	String	Non	URL de l'avatar du contact.
last_activity_at	String	Non	Horodatage de la dernière mise à jour.
created_at	String	Non	Horodatage de création.
first_name	String	Non	Prénom du contact.
last_name	Array	Non	Nom de famille du contact.
custom_attributes	object	Champs personnalisés

Exemple de réponse

{ "payload": { "additional_attributes": { "description": "", "company_name": "", "city": "", "telegram": "", "country": "", "country_code": "", "social_profiles": { "facebook": "", "github": "", "instagram": "", "linkedin": "", "twitter": "" } }, "availability_status": "offline", "email": "support@jiguang.cn", "id": 318763, "name": "support", "phone_number": null, "blocked": false, "identifier": "2222", "thumbnail": "", "custom_attributes": {}, "last_activity_at": 1765441908, "created_at": 1765441895, "contact_inboxes":[ { "source_id": "src_001", "inbox": { "id": 10, "name": "Canal du service client", "channel_type": "Channel::Api" } } ] } }

              
              {
    "payload": {
        "additional_attributes": {
            "description": "",
            "company_name": "",
            "city": "",
            "telegram": "",
            "country": "",
            "country_code": "",
            "social_profiles": {
                "facebook": "",
                "github": "",
                "instagram": "",
                "linkedin": "",
                "twitter": ""
            }
        },
        "availability_status": "offline",
        "email": "support@jiguang.cn",
        "id": 318763,
        "name": "support",
        "phone_number": null,
        "blocked": false,
        "identifier": "2222",
        "thumbnail": "",
        "custom_attributes": {},
        "last_activity_at": 1765441908,
        "created_at": 1765441895,
        "contact_inboxes":[
        {
         "source_id": "src_001",
          "inbox": {
          "id": 10,
          "name": "Canal du service client",
          "channel_type": "Channel::Api"
        }
      }
    ]
    }
}

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de réponse

Champ	Type	Obligatoire	Description
payload	Object	Non	Structure des attributs.
additional_attributes	Object	Non	Attributs supplémentaires.
availability_status	String	Non	Statut en ligne. La valeur par défaut est `offline`.
email	String	Non	Adresse e-mail.
id	String	Non	ID du contact.
name	String	Non	Nom.
phone_number	String	Non	Numéro de téléphone.
blocked	String	Non	Indique si le contact est bloqué. La valeur par défaut est `false`.
identifier	String	Non	Identifiant externe unique du contact, correspondant au UserID affiché dans l'interface.
thumbnail	String	Non	URL de l'avatar.
custom_attributes	String	Non	Attributs du contact.
created_at	String	Non	Horodatage de création.
last_activity_at	String	Non	Horodatage de la dernière mise à jour.
contact_inboxes	array	Informations sur les canaux associés, renvoyées uniquement lorsque `include_contact_inboxes=true`.
source_id	String	Non	ID de source.
inbox	Object	Non	Informations sur la boîte de réception.
id	Integer	Non	ID de la boîte de réception.
name	String	Non	Nom de la boîte de réception.
channel_type	String	Non	Type de canal.