Gestión de Etiquetas de Campaña

URL base (Endpoint)

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

Al utilizar la API REST, combine la URL base seleccionada con la ruta de la API específica para obtener la URL completa del endpoint.

POST/v1/marketing/campaigns/tags

Crear Etiquetas de Campaña

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

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

Método 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

Headers de la Solicitud (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del Body (Body Parameters)

Parameter	Type	Required	Description
tag_names	array[string]	true	Nombres de las etiquetas. Longitud máxima: 64 caracteres. Solo se admiten a-z, A-Z, 0-9, _, caracteres chinos, etc.

Notas:

Cada organización puede crear hasta 100 etiquetas.
Los nombres de las etiquetas deben ser únicos.

Ejemplo de Solicitud (Request Example)

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags) --data '{ "tag_names": ["promocion_buen_fin", "nuevos_usuarios"] }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags) --data '{
    "tag_names": ["promocion_buen_fin", "nuevos_usuarios"]
}'

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

Ejemplo de Respuesta (Response Example)

Response-Success

HttpStatus: 200

{ "count": 2 }

              
              {
    "count": 2
}

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

Response-Error

HttpStatus: 401

{ "code": 32603, "message": "tag name already exist" }

              
              {
    "code": 32603,
    "message": "tag name already exist"
}

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

Listar Etiquetas de Campaña

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

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

Método 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

Headers de la Solicitud (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros de Consulta (Query Parameters)

Parameter	Type	Required	Description
tag_name	string	false	Nombre de la etiqueta (búsqueda difusa)
offset	integer	false	Desplazamiento del registro. Rango de valores: [0-]. Por defecto: 0
limit	integer	false	Número de registros a recuperar. Rango de valores: [1-100]. Por defecto: 10

Ejemplo de Solicitud (Request Example)

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promocion&limit=10&offset=0](https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promocion&limit=10&offset=0)

              
              curl -X GET -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promocion&limit=10&offset=0](https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promocion&limit=10&offset=0)

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

Campos de la Respuesta (Response Fields)

Parameter	Type	Description
tag_id	string	ID de la etiqueta
tag_name	string	Nombre de la etiqueta
create_time	string	Hora de creación
update_time	string	Hora de actualización

Ejemplo de Respuesta (Response Example)

Response-Success

HttpStatus: 200

{ "result": [ { "tag_id": "64a1f2e0c9e1a23456789012", "tag_name": "promocion_buen_fin", "create_time": "2024-01-15T10:30:00+0800", "update_time": "2024-01-16T14:20:00+0800" }, { "tag_id": "64a1f2e0c9e1a23456789013", "tag_name": "nuevos_usuarios", "create_time": "2024-01-14T08:00:00+0800", "update_time": "2024-01-14T08:00:00+0800" } ], "total": 2, "count": 2 }

              
              {
    "result": [
        {
            "tag_id": "64a1f2e0c9e1a23456789012",
            "tag_name": "promocion_buen_fin",
            "create_time": "2024-01-15T10:30:00+0800",
            "update_time": "2024-01-16T14:20:00+0800"
        },
        {
            "tag_id": "64a1f2e0c9e1a23456789013",
            "tag_name": "nuevos_usuarios",
            "create_time": "2024-01-14T08:00:00+0800",
            "update_time": "2024-01-14T08:00:00+0800"
        }
    ],
    "total": 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

Actualizar Etiqueta de Campaña

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}

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

Método 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

Headers de la Solicitud (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros de Ruta (Path Parameters)

Parameter	Type	Required	Description
tag_id	string	true	ID de la etiqueta

Parámetros del Body (Body Parameters)

Parameter	Type	Required	Description
tag_name	string	true	Nombre de la etiqueta. Solo se admiten caracteres chinos, letras inglesas mayúsculas y minúsculas, dígitos y guiones bajos. Longitud: 1-64 caracteres.

Ejemplo de Solicitud (Request Example)

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012) --data '{ "tag_name": "promocion_618" }'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012) --data '{
    "tag_name": "promocion_618"
}'

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

Ejemplo de Respuesta (Response Example)

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }

              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}

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

Eliminar Etiqueta de Campaña

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)

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

Método 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

Headers de la Solicitud (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

Notas:

Después de eliminar una etiqueta, las campañas asociadas se desvincularán automáticamente de dicha etiqueta.

Ejemplo de Solicitud (Request Example)

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

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

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

Ejemplo de Respuesta (Response Example)

Response-Success

HttpStatus: 200

{ "count": 2 }

              
              {
    "count": 2
}

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

Response-Error

HttpStatus: 401

{ "code": 32606, "message": "tag_id cannot be empty" }

              
              {
    "code": 32606,
    "message": "tag_id cannot be empty"
}

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

Añadir Etiquetas a Campañas

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/add

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/add

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

Método 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

Headers de la Solicitud (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del Body (Body Parameters)

Parameter	Type	Required	Description
campaign_ids	array[string]	*	Lista de IDs de campaña. Hasta 200 IDs por solicitud.

Notas:

Cada campaña puede tener un máximo de 20 etiquetas.

Ejemplo de Solicitud (Request Example)

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add) --data '{ "campaign_ids": [ "61c2be010d2b4e6a3836ab1f", "61c2be010d2b4e6a3836ab1d" ] }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add) --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

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

Ejemplo de Respuesta (Response Example)

Response-Success

HttpStatus: 200

{ "total": 3 }

              
              {
    "total": 3
}

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

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }

              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}

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

Eliminar Etiquetas de Campañas

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/remove

              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/remove

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

Método 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

Headers de la Solicitud (Request Headers)

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del Body (Body Parameters)

Parameter	Type	Required	Description
campaign_ids	array[string]	*	Lista de IDs de campaña. Hasta 200 IDs por solicitud.

Ejemplo de Solicitud (Request Example)

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove) --data '{ "campaign_ids": [ "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/campaigns/tags/616683a13a7b531b0336108d/remove](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove) --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'

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

Ejemplo de Respuesta (Response Example)

Response-Success

HttpStatus: 200

{ "total": 3 }

              
              {
    "total": 3
}

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

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }

              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}

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