MailingBoss 5.0 – Integración con API

1. Ubicar el Token – Clave de integración para autenticación #

El token necesario para autenticar las solicitudes a la API se encuentra en la sección “Clave de Integración” de MailingBoss 5.0.

Desde el menú lateral de MailingBoss 5.0, accede a la opción “Integración”.

Haz clic en “Copiar” o selecciona y copia (CTRL+C) la clave de integración para pegarla en otra herramienta o directamente en el código requerido.

2. Método para obtener las listas #

Para obtener todas las listas de usuarios, es necesario realizar una solicitud GET a la siguiente URL:

https://member.mailingboss.com/integration/index.php/lists/<TOKEN>

Ejemplo de solicitud GET:

GET /integration/index.php/lists/<TOKEN>
HOST: member.mailingboss.com

Ejemplo de respuesta JSON:

{
	status: "success", data: [
			{
				list_uid: "m07ug174cie26",
				name: "E-mail Marketing",
				display_name: "E-mail Marketing",
				description: "E-mail Marketing"
			},
			{
				list_uid: "mj546z2pwp2de",
				name: "Form name / List Test",
				display_name: "List Test",
				description: "List Test"
			}
			]
}

3. Método para obtener los campos personalizados #

Para obtener todos los campos personalizados, es necesario realizar una solicitud POST a la siguiente URL:

https://member.mailingboss.com/integration/index.php/lists/fields/<TOKEN>

Ejemplo de solicitud POST:

POST /integration/index.php/lists/fields/<TOKEN>
HOST: member.mailingboss.com

PARÁMETROS – Form Data o JSON:

list_uid: STRING (ej.: vh485p76so057)

Ejemplo de respuesta JSON:

{
	status: "success",
	data: [
			{
				label: "Email",
				tag: “EMAIL",
				type: “text”,
				required: “yes”,
				options: []
			},
			{
				label: "Gender",
				tag: “GENDER",
				type: “dropdown”,
				required: “no”,
				options: [
					{
							name: “Male”,
							value: "male"
					},
					{
							name: “Female”,
							value: "female"
					}
				]
			}
			]
}

Solicitudes JSON:
Ten en cuenta que el encabezado de la solicitud debe especificar el tipo de contenido, por ejemplo:
Content-Type: application/json

4. Agregar un suscriptor (lead) a una lista #

Para asociar un lead a una lista, es necesario realizar una solicitud POST a la siguiente URL:

https://member.mailingboss.com/integration/index.php/lists/subscribers/create/<TOKEN>

Se deben enviar los siguientes campos: email, list_uid y taginternals.

¡Atención!
Para evitar posibles errores, NO agregues todos los parámetros en la URL.
La URL debe contener ÚNICAMENTE el TOKEN. Los demás parámetros deben enviarse en el lugar donde se recopiló la información (cuerpo de la solicitud).

Ejemplo de solicitud POST:

POST /integration/index.php/lists/subscribers/create/<TOKEN>
HOST: member.mailingboss.com

PARÁMETROS – Form Data o JSON:

email: STRING (ej.: teste@teste.com)
list_uid: STRING (ej.: vh485p76so057)
taginternals: STRING (ej.: testetag, tag2)

Ejemplo de respuesta JSON:

{
	status: "success",
	data: {
			subscriber_uid: "ow305e5oat103",
			email: "teste@teste.com", taginternals:
			"testetag, tag2", status: "confirmed"
	}
}

Ejemplo de solicitud POST usando campos personalizados:

POST /integration/index.php/lists/subscribers/create/<TOKEN>
HOST: member.mailingboss.com

PARÁMETROS – Form Data o JSON:

email: STRING (ej.: teste@teste.com)
list_uid: STRING (ej.: vh485p76so057)
taginternals: STRING (ej.: testetag, tag2)
gender: STRING VALUE
fname: STRING VALUE
lname: STRING VALUE

Ejemplo de respuesta JSON:

{
	status: "success",
	data: {
			subscriber_uid: "ow305e5oat103",
			email: "teste@teste.com", taginternals:
			"testetag, tag2", status: "confirmed"
	}
}

Solicitudes JSON:
Asegúrate de que el encabezado de la solicitud especifique el tipo de contenido, por ejemplo:
Content-Type: application/json

5. Buscar un suscriptor (lead) por correo electrónico #

Para buscar un lead por correo electrónico, es necesario realizar una solicitud POST a la siguiente URL:

https://member.mailingboss.com/integration/index.php/lists/subscribers/search-by-email/<TOKEN>

Se deben enviar los siguientes campos: email y list_uid.

Ejemplo de solicitud POST:

POST /integration/index.php/lists/subscribers/search-by-email/<TOKEN>
HOST: member.mailingboss.com

PARÁMETROS – Form Data o JSON:

email: STRING (ej.: teste@teste.com)
list_uid: STRING (ej.: vh485p76so057)

Ejemplo de respuesta JSON:

{
	status: "success",
	data: {
			email: "teste@teste.com", status:
			"confirmed", subscriber_uid:
			"ow305e5oat103", taginternals:
			"testetag, tag2"
	}
}

Solicitudes JSON:
Asegúrate de que el encabezado de la solicitud especifique el tipo de contenido, por ejemplo:
Content-Type: application/json

6. Actualizar datos del lead #

Puedes actualizar el email, las etiquetas y los valores de campos personalizados de un lead realizando una solicitud POST a la siguiente URL:

https://member.mailingboss.com/integration/index.php/lists/subscribers/update/<TOKEN>

Se deben enviar los siguientes campos: subscriber_uid (opcional), list_uid, email y taginternals.

Ejemplo de solicitud POST:

POST /integration/index.php/lists/subscribers/update/<TOKEN>
HOST: member.mailingboss.com

PARÁMETROS – Form Data o JSON:

subscriber_uid: STRING (ej.: ho984vsr8af13)
list_uid: STRING (ej.: vh485p76so057)
email: STRING (ej.: teste@teste.com)
taginternals: STRING (ej.: testetag, tag2)
taginternals_remove: STRING (ej.: tag1)

Ejemplo de respuesta JSON:

{
  "status": "success"
}

Ejemplo de solicitud POST usando campos personalizados:

POST /integration/index.php/lists/subscribers/update/<TOKEN>
HOST: member.mailingboss.com

PARÁMETROS – Form Data o JSON:

subscriber_uid: STRING (ej.: ho984vsr8af13)
list_uid: STRING (ej.: vh485p76so057)
email: STRING (ej.: teste@teste.com)
taginternals: STRING (ej.: testetag, tag2)
taginternals_remove: STRING (ej.: tag1)
gender: STRING VALUE
fname: STRING VALUE
lname: STRING VALUE

Ejemplo de respuesta JSON:

{
  "status": "success"
}

Solicitudes JSON:
Asegúrate de que el encabezado de la solicitud especifique el tipo de contenido, por ejemplo:
Content-Type: application/json

7. Cancelar la suscripción de un lead a una lista #

Para cancelar la suscripción de un lead a una lista específica, realiza una solicitud POST a la siguiente URL:

https://member.mailingboss.com/integration/index.php/lists/subscribers/unsubscribe/<TOKEN>

Se deben enviar los siguientes campos: subscriber_uid y list_uid.

Ejemplo de solicitud POST:

POST /integration/index.php/lists/subscribers/unsubscribe/<TOKEN>
HOST: member.mailingboss.com

PARÁMETROS – Form Data o JSON:

subscriber_uid: STRING (ej.: ho984vsr8af13)
list_uid: STRING (ej.: vh485p76so057)

Ejemplo de respuesta JSON:

{
  "status": "success"
}

Solicitudes JSON:
Asegúrate de que el encabezado de la solicitud especifique el tipo de contenido, por ejemplo:
Content-Type: application/json

8. Eliminar un suscriptor (lead) de una lista #

Para eliminar permanentemente un lead de una lista específica, realiza una solicitud POST a la siguiente URL:

https://member.mailingboss.com/integration/index.php/lists/subscribers/delete/<TOKEN>

Se deben enviar los siguientes campos: subscriber_uid y list_uid.

Ejemplo de solicitud POST:

POST /integration/index.php/lists/subscribers/delete/<TOKEN>
HOST: member.mailingboss.com

PARÁMETROS – Form Data o JSON:

subscriber_uid: STRING (ej.: ho984vsr8af13)
list_uid: STRING (ej.: vh485p76so057)

Ejemplo de respuesta JSON:

{
  "status": "success"
}

Solicitudes JSON:
Asegúrate de que el encabezado de la solicitud especifique el tipo de contenido, por ejemplo:
Content-Type: application/json