members

Dirección de petición

Centro de datos	URL
Singapur	https://email.api.engagelab.cc
Turquía	https://emailapi-tr.engagelab.com

Al utilizar la API REST, se debe verificar que el centro de datos seleccionado corresponda a la URL base adecuada.

POST/v1/marketing/lists/members

Adición o actualización por lotes

URL

https://email.api.engagelab.cc/v1/marketing/lists/members

              
              https://email.api.engagelab.cc/v1/marketing/lists/members

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

Método de solicitud HTTP

POST

              
              POST

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
members	array[object]	true	Lista de miembros, hasta un máximo de 1000
email	string	true	Dirección de correo electrónico
phone	string	false	Número de teléfono
name	string	false	Alias
fields	object	false	Campos de contacto
tags	string[]	false	Lista de nombres de etiqueta
tag_flag	integer	false	Método de actualización de etiquetas: 0 para sobrescribir, 1 para anexar, 2 para omitir (el valor predeterminado es 1)
update_existing	boolean	true	Si se deben actualizar las propiedades si la dirección ya existe

Nota:

Si el campo Email de un miembro es igual al valor del parámetro members.email, se considera una actualización del miembro. De lo contrario, se considera la adición de un nuevo miembro.
Los distintos valores de tag_flag corresponden a diferentes formas de actualizar las etiquetas. Consultar el siguiente ejemplo:

tag_flag	Etiquetas originales	Parámetro tags	Nuevas etiquetas
0	[1,2,3]	[]	[]
0	[1,2,3]	null, no se pasó ningún valor	[1,2,3]
0	[1,2,3]	[3,4,5]	[3,4,5]
1	[1,2,3]	[]	[1,2,3]
1	[1,2,3]	null, no se pasó ningún valor	[1,2,3]
1	[1,2,3]	[3,4,5]	[1,2,3,4,5]
2	[1,2,3]	[]	[1,2,3]
2	[1,2,3]	null, no se pasó ningún valor	[1,2,3]
2	[1,2,3]	[3,4,5]	[1,2,3]
2	[]	[3,4,5]	[]

Ejemplo de solicitud

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members --data '{"members":[{"email":"xjmfc@126.com","phone":"13681312919","name":"Zhusuosuo","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}],"tag_flag":0,"update_existing":true}'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' 
-i https://email.api.engagelab.cc/v1/marketing/lists/members 
--data '{"members":[{"email":"xjmfc@126.com","phone":"13681312919","name":"Zhusuosuo","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}],"tag_flag":0,"update_existing":true}'

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

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "created_count": 2, "created_members": [{ "email": "202205ab233444444444446@qq.com", "member_id": "6294b0fa490f33c5ee3b5b0c" },{ "email": "202205ab3331@qq.com", "member_id": "6294b0fa490f33c5ee3b5b0d" }], "updated_count": 2, "updated_members": [{ "email": "202205ab233444444444447@qq.com", "member_id": "6294b0fa490f33c5ee3b5b1c" },{ "email": "202205ab3332@qq.com", "member_id": "6294b0fa490f33c5ee3b5b1d" }], "error_count": 2, "error_members": [{ "email": "202205ab233444444444446@qq.com", "message": "..." },{ "email": "202205ab3331@qq.com", "message": "..." }] }

              
              {
    "created_count": 2,
    "created_members": [{
            "email": "202205ab233444444444446@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b0c"
        },{
            "email": "202205ab3331@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b0d"
    }],
    "updated_count": 2,
    "updated_members": [{
            "email": "202205ab233444444444447@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b1c"
        },{
            "email": "202205ab3332@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b1d"
    }],
    "error_count": 2,
    "error_members": [{
            "email": "202205ab233444444444446@qq.com",
            "message": "..."
        },{
            "email": "202205ab3331@qq.com",
            "message": "..."
    }]
}

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

Response-Error

{ "code": 30000, "message": "Authentication failed" }

              
              {
    
    "code": 30000,
    "message": "Authentication failed"
      
}

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

Eliminar

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

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

Método de solicitud HTTP

DELETE

              
               DELETE

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

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

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

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Ejemplo de solicitud

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/8

              
              curl -X DELETE -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/8

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

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

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

Eliminación por lotes

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/delete

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/delete

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

Método de solicitud HTTP

DELETE

              
              DELETE

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
condition	object	false	Condición de consulta
relation	string	true	Relación de condiciones (and u or)
items	object[]	true	Condiciones de filtrado: admite hasta 10 condiciones de filtrado. Cuando todas las condiciones tienen la misma relación (todas "and" o todas "or")
field_name	string	true	field_name representa el nombre del atributo y value representa el valor del campo. Cuando field_name es tag, value = nombre de la etiqueta
op	string	true	Operador (==, !=, >, >=, <, <=, exist, contain, does not contain)
value	string	true	Cuando field_name es tag, value = nombre de la etiqueta Cuando field_name es un nombre de atributo, consultar Condiciones de filtrado para el formato.

Nota

La relación entre field_name y op se puede consultar aquí: Condiciones de filtrado

Ejemplo de solicitud

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/delete --data ' { "condition": { "relation": "or", "items": [ { "field_name": "Email", "op": "contain", "value": "hotmail.com" }, { "field_name": "Phone", "op": "contain", "value": "188" } ] } } '

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/delete --data '
{
    "condition": {
        "relation": "or",
        "items": [
            {
                "field_name": "Email",
                "op": "contain",
                "value": "hotmail.com"
            },
            {
                "field_name": "Phone",
                "op": "contain",
                "value": "188"
            }
        ]
    }
}
'

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

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

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

Actualizar

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

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

Método de solicitud HTTP

PUT

PUT

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
phone	string	false	Número de teléfono
name	string	false	Alias
fields	object	false	Campos del miembro
tags	string[]	false	Lista de nombres de etiquetas

Ejemplo de solicitud

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2 --data '{"phone":"13681312919","name":"朱锁锁","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i 
https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2 
--data '{"phone":"13681312919","name":"朱锁锁","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}'

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

Detalles del miembro

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

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

Método de solicitud HTTP

GET

GET

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

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

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

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Lista de miembros

URL

https://email.api.engagelab.cc/v1/marketing/lists/list_members

              
              https://email.api.engagelab.cc/v1/marketing/lists/list_members

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

Método de solicitud HTTP

POST

              
              POST

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
condition	object	false	Condición de consulta
relation	string	true	Relación de condiciones (and u or)
items	object[]	true	Condiciones de filtrado. Admite hasta 10 condiciones de filtrado; según la relación especificada, todas las condiciones serán "and" o todas "or"
field_name	string	true	field_name representa el nombre del campo y value representa el valor del campo; Cuando field_name es tag, value=nombre de la etiqueta
op	string	true	Operador (==, !=, >, >=, <, <=, exist, contain, does not contain)
value	string	true	Cuando field_name es tag, value=nombre de la etiqueta Cuando field_name es un nombre de campo, consultar el formato del valor en filter-conditions

Nota:

Consultar la relación correspondiente entre field_name y op en filter-conditions

Miembros

Dirección de petición

Adición o actualización por lotes

Eliminar

Eliminación por lotes

Actualizar

Detalles del miembro

Lista de miembros