Actualizar contacto

Los desarrolladores pueden actualizar la información del contacto a través de la API.

Método de solicitud

PATCH

URL de solicitud

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

Autenticación

Para más información, consulte la descripción del método de autenticación en Descripción general de la API.

Solicitud

Ejemplo de solicitud

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": { // Opcional: fusiona y actualiza los campos personalizados (fusión incremental) "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": 
    {                  // Opcional: fusiona y actualiza los campos personalizados (fusión incremental)
    "vip_level": "platinum"
    },
    "created_at": 1765441895,
    "first_name": "support",
    "last_name": ""
}

Este bloque de código se muestra en una ventana flotante

Encabezados de solicitud

Campo	Tipo	Descripción
Authorization	string	Use `Authorization: Basic base64(API Key:API Secret)` para la autenticación. Vaya a la página de API Key para obtener la API Key y el API Secret, únalos con dos puntos y luego codifíquelos en Base64.
Content-Type	application/json	Este es el formato de datos de la solicitud. Use `application/json`.

Parámetros de ruta

Campo	Tipo	Obligatorio	Descripción
account	integer	Sí	ID de la cuenta
id	integer	Sí	ID del contacto

Parámetros del cuerpo de la solicitud

Campo	Tipo	Obligatorio	Descripción
additional_attributes	Object	No	Atributos adicionales.
description	Object	No	Información descriptiva.
company_name	String	No	Nombre de la empresa.
city	String	No	Ciudad.
telegram	String	No	Contacto de Telegram.
country	String	No	País.
country_code	String	No	Código del país.
social_profiles	String	No	Contactos de redes sociales.
availability_status	String	No	Estado en línea. El valor predeterminado es `offline`.
email	String	No	Dirección de correo electrónico.
name	String	No	Nombre.
phone_number	String	No	Número de teléfono.
blocked	String	No	Indica si está bloqueado. El valor predeterminado es `false`.
identifier	String	No	Identificador externo único del contacto, correspondiente al UserID mostrado en la interfaz.
thumbnail	String	No	URL del avatar del contacto.
last_activity_at	String	No	Marca de tiempo de la última actualización.
created_at	String	No	Marca de tiempo de creación.
first_name	String	No	Nombre del contacto.
last_name	Array	No	Apellido del contacto.
custom_attributes	object	Campos personalizados

Ejemplo de respuesta

{ "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 de atención al cliente", "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 de atención al cliente",
          "channel_type": "Channel::Api"
        }
      }
    ]
    }
}

Este bloque de código se muestra en una ventana flotante

Parámetros de respuesta

Campo	Tipo	Obligatorio	Descripción
payload	Object	No	Estructura de atributos.
additional_attributes	Object	No	Atributos adicionales.
availability_status	String	No	Estado en línea. El valor predeterminado es `offline`.
email	String	No	Dirección de correo electrónico.
id	String	No	ID del contacto.
name	String	No	Nombre.
phone_number	String	No	Número de teléfono.
blocked	String	No	Indica si está bloqueado. El valor predeterminado es `false`.
identifier	String	No	Identificador externo único del contacto, correspondiente al UserID mostrado en la interfaz.
thumbnail	String	No	URL del avatar.
custom_attributes	String	No	Atributos del contacto.
created_at	String	No	Marca de tiempo de creación.
last_activity_at	String	No	Marca de tiempo de la última actualización.
contact_inboxes	array	Información de los canales asociados; solo se devuelve cuando `include_contact_inboxes=true`.
source_id	String	No	ID de origen.
inbox	Object	No	Información de la bandeja de entrada.
id	Integer	No	ID de la bandeja de entrada.
name	String	No	Nombre de la bandeja de entrada.
channel_type	String	No	Tipo de canal.