Mettre à jour un contact | LiveDesk API Contact Français

Les développeurs peuvent mettre à jour les informations d'un 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 méthode d'authentification décrite dans Vue d'ensemble 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)' \ -d '{ "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": { // Facultatif : fusionner et mettre à jour les champs personnalisés (fusion incrémentielle) "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)' \
-d '{
    "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": {
        // Facultatif : fusionner et mettre à jour les champs personnalisés (fusion incrémentielle)
        "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

Field	Type	Description
Authorization	string	Utilisez `Authorization: Basic base64(API Key:API Secret)` pour l'authentification. Accédez à la page API Keys pour obtenir l'API Key et l'API Secret, joignez-les avec deux-points, puis encodez-les en Base64.
Content-Type	application/json	Type de données. Utilisez `application/json` pour les messages texte standards.

Paramètres de chemin

Field	Type	Required	Description
account	integer	Yes	ID du projet LiveDesk.
id	integer	Yes	ID du contact.

Paramètres du corps de la requête

Field	Type	Required	Description
additional_attributes	Object	No	Attributs supplémentaires.
description	Object	No	Description.
company_name	String	No	Nom de l'entreprise.
city	String	No	Ville.
telegram	String	No	Coordonnées Telegram.
country	String	No	Pays.
country_code	String	No	Indicatif du pays.
social_profiles	String	No	Coordonnées sur les réseaux sociaux.
availability_status	String	No	Statut de disponibilité. La valeur par défaut est `offline`.
email	String	No	Adresse e-mail.
name	String	No	Nom.
phone_number	String	No	Numéro de téléphone.
blocked	Boolean	No	Indique si le contact est bloqué. La valeur par défaut est `false`.
identifier	String	No	Identifiant externe unique du contact, correspondant au UserID affiché dans l'interface.
thumbnail	String	No	URL de l'avatar du contact.
last_activity_at	String	No	Horodatage de la dernière mise à jour.
created_at	String	No	Horodatage de création.
first_name	String	No	Prénom du contact.
last_name	String	No	Nom de famille du contact.
custom_attributes	Object	No	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

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