Gestión de etiquetas

Dirección de solicitud

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 corresponde a la URL base adecuada.

POST/v1/marketing/lists/tags

Crear

URL

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

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

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
tag_name	string	true	Nombre de la etiqueta, hasta 64 caracteres, compuesto únicamente por a-z, A-z, 0-9, _, caracteres chinos, etc.

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/tags --data '{ "name": "myCustomTag" }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags --data '{
  "name": "myCustomTag"
}'

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

Ejemplo de respuesta

Response-Success

HttpStatus:200

{ "result":{ "tag_id": "62732d3ddd017d22ccd118e4", "tag_name": "education", "create_time": "2023-11-28T11:14:48+0800", "update_time": "2023-11-28T11:14:48+0800" } }

              
              {
    "result":{
      "tag_id": "62732d3ddd017d22ccd118e4",
      "tag_name": "education",
      "create_time": "2023-11-28T11:14:48+0800",
      "update_time": "2023-11-28T11:14:48+0800"
    }
}

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

Eliminar

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_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/tags/61c2be010d2b4e6a3836ab1f

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

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

{ "code": 30036, "message": "resource not found" }

              
              {
    "code": 30036,
    "message": "resource not found"
}

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

Actualizar

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_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
tag_name	string	false	Nombre de la etiqueta, hasta 64 caracteres, compuesto únicamente por a-z, A-z, 0-9, _, caracteres chinos, etc.

Ejemplo de solicitud

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/lists/tags/617a71ac672b2823a1a82c13 --data '{ "name": "myCustomTag" }'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/lists/tags/617a71ac672b2823a1a82c13 --data '{
  "name": "myCustomTag"
}'

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: 400

{ "code": 30035, "message": "Tag name only consists of a-z, A-z, 0-9, _,chinese character, up to 64 characters" }

              
              {
    "code": 30035,
    "message": "Tag name only consists of a-z, A-z, 0-9, _,chinese character, up to 64 characters"
}

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

Lista de etiquetas

URL

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

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

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)

Parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
tag_name	string	false	Consultar el nombre de la etiqueta (admite consulta difusa)
offset	integer	false	Posición inicial de la consulta; rango de valores [0-]; el valor predeterminado es 0
limit	integer	false	Número de registros; rango de valores [1-100]; el valor predeterminado es 10

Ejemplo de solicitud

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags?offset=0&limit=10&name=education

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags?offset=0&limit=10&name=education

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

Parámetros de respuesta

Parámetro	Tipo	Descripción
result	array[object]	Lista de etiquetas
tag_id	string	ID de etiqueta
tag_name	string	Nombre de la etiqueta
create_time	string	Hora de creación
update_time	string	Hora de actualización
count	integer	Número de miembros con la etiqueta
total	integer	Número total de registros
count	integer	Número de registros devueltos

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "result": [ { "tag_id": "617a71ac672b2823a1a82c13", "tag_name": "education", "create_time": "2023-11-28T11:14:48+0800", "update_time":"2023-11-28T11:14:48+0800", "count": 1 } ], "count": 1, "total": 1 }

              
              {
  "result": [
    {
      "tag_id": "617a71ac672b2823a1a82c13",
      "tag_name": "education",
      "create_time": "2023-11-28T11:14:48+0800",
      "update_time":"2023-11-28T11:14:48+0800",
      "count": 1
    }
  ],
  "count": 1,
  "total": 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

Añadir etiquetas a miembros

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/add

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/add

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
member_ids	string[]	true	Lista de ID de miembros; máximo 1000 ID de miembros por solicitud

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/tags/61c2be010d2b4e6a3836ab1f/add --data '{
  "member_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

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

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "count": 2 }

              
              {
 "count": 2
}

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

Eliminar etiquetas de miembros

URL

https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove

              
              https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove

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	Bearer Token

Parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
member_ids	array[string]	true	Lista de ID de miembros; máximo 1000 ID de miembros por solicitud

Ejemplo de solicitud

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/remove --data '{ "memberIds": [ "61c2be010d2b4e6a3836ab1f", "61c2be010d2b4e6a3836ab1d" ] }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/remove --data '{
  "memberIds": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

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

Obtener miembros

URL

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

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

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	Bearer Token

Parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
offset	integer	false	Posición inicial de la consulta; rango de valores [0-]; el valor predeterminado es 0
limit	integer	false	Número de registros; rango de valores [1-100]; el valor predeterminado es 10

Ejemplo de solicitud

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/members?offset=0&limit=10

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/members?offset=0&limit=10

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

Parámetros de respuesta

Parámetro	Tipo	Descripción
result	object	Lista de miembros
member_id	string	ID de miembro
list_id	integer	ID de lista
email	string	Dirección de correo electrónico
phone	string	Número de teléfono
name	string	Nombre
create_time	string	Hora de creación (UTC+8)
update_time	string	Hora de actualización (UTC+8)
unsubscribe_time	string	Hora de cancelación de suscripción (UTC+8)
fields	object	Campos del miembro
tag_ids	array[string]	Conjunto de ID de etiquetas
tag_names	array[string]	Conjunto de nombres de etiquetas
total	integer	Total de registros que coinciden con la consulta

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "result": [ { "member_id": "6565c12a3b4e0d83d3f58ea0", "list_id": 95964, "email": "xjmfc@126.com", "phone": null, "name": null, "fields": { "Birthday": "03/30", "Age": "12" }, "tag_ids": [ "646f28a7cac6587565ad6918" ], "tag_names": [ "test" ], "create_time": "2023-11-28T18:30:02+0800", "update_time": "2023-11-30T16:42:11+0800", "unsubscribe_time": null } ], "total": 2, "count": 1 }

              
              {
    "result": [
        {
            "member_id": "6565c12a3b4e0d83d3f58ea0",
            "list_id": 95964,
            "email": "xjmfc@126.com",
            "phone": null,
            "name": null,
            "fields": {
                "Birthday": "03/30",
                "Age": "12"
            },
            "tag_ids": [
                "646f28a7cac6587565ad6918"
            ],
            "tag_names": [
                "test"
            ],
            "create_time": "2023-11-28T18:30:02+0800",
            "update_time": "2023-11-30T16:42:11+0800",
            "unsubscribe_time": null
        }
    ],
    "total": 2,
    "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

Etiquetas

Dirección de solicitud

Crear

Eliminar

Actualizar

Lista de etiquetas

Añadir etiquetas a miembros

Eliminar etiquetas de miembros

Obtener miembros