Desarrolladores

Documentación de la API

Todo lo que expone Emboxia para integrarla con tus sistemas: listas, campañas, contactos y notificaciones de entrega.

URL base

https://app.emboxia.com/api/v1

Autenticación

Añade el parámetro api_token a cada petición. Lo encuentras en tu panel, en «API de campaña».

Autenticación

POST/api/v1/user/loginObtener un token de API con correo y contraseña

Obtener un token de API con correo y contraseña

Parámetros

email: User's email
password: User's password

Devuelve

API Token

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/user/login \
-d email=user@example.com \
-d password=yourpassword

POST/api/v1/login-tokenGenerar un token de acceso de un solo uso

Generar un token de acceso de un solo uso

Devuelve

Token string

User can login by visiting the following URL:
https://app.emboxia.com/login/token/*|token_string|*

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/login-token \
-d api_token=TU_TOKEN_DE_API

LISTAS

POST/api/v1/listsNueva lista

Nueva lista

Parámetros

$name: List's name
$from_email: Default From email address
$from_name: Default From name
divider: Contact information
$contact[company]: Name
$contact[state]: State / Province / Region
$contact[address_1]: Address 1
$contact[address_2]: Address 2
$contact[city]: City
$contact[zip]: Zip / Postal code
$contact[phone]: Phone
$contact[country_id]: Country id
$contact[email]: Email
$contact[url]Opcional: Home page
$subscribe_confirmation: Send subscription confirmation email (Double Opt-In)
$send_welcome_email: Send a final welcome email
$unsubscribe_notification: Send unsubscribe notification to subscribers
$send_welcome_email: Send a final welcome email

Devuelve

Creation messages in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists \
-d api_token=TU_TOKEN_DE_API \
-d name=List+1 \
-d from_email=admin@abccorp.org \
-d from_name=ABC+Corp. \
-d contact[company]=ABC+Corp. \
-d contact[state]=Armagh \
-d contact[address_1]=14+Tottenham+Court+Road+London+England \
-d contact[address_2]=44-46+Morningside+Road+Edinburgh+Scotland+EH10+4BF \
-d contact[city]=Noname \
-d contact[zip]=80000 \
-d contact[phone]=123+456+889 \
-d contact[country_id]=1 \
-d contact[email]=info@abccorp.org \
-d contact[url]=http://www.abccorp.org \
-d subscribe_confirmation=1 \
-d send_welcome_email=1 \
-d unsubscribe_notification=1

GET/api/v1/listsVer todas las listas

Ver todas las listas

Devuelve

List of all user's mail lists in json

Ejemplo

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists \
-d api_token=TU_TOKEN_DE_API

GET/api/v1/lists/{uid}Ver una lista concreta

Ver una lista concreta

Devuelve

All list informations in json

Ejemplo

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{uid} \
-d api_token=TU_TOKEN_DE_API

POST/api/v1/lists/{uid}/add-fieldAñadir un campo personalizado a la lista

Añadir un campo personalizado a la lista

Parámetros

$type: Choose one of these types: text, number, datetime.
$label: Field' label
$tag: The tag name may have alpha-numeric characters, as well as dashes and underscores.
$default_valueOpcional: Default value of the field

Devuelve

Creation messages in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{uid}/add-field \
-d api_token=TU_TOKEN_DE_API \
-d type=text \
-d label=Custom \
-d tag=CUSTOM_FIELD_1 \
-d default_value=test

DELETE/api/v1/lists/{uid}Borrar una lista

Borrar una lista

Parámetros

$uid: List's uid

Devuelve

Result messages in json

Ejemplo

curl -X DELETE -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{uid} \
-d api_token=TU_TOKEN_DE_API

Campañas

GET/api/v1/campaignsVer todas las campañas

Ver todas las campañas

Parámetros

$per_pageOpcional: Number of subscribers per page
$page: Page number

Devuelve

List of all user's campaigns in json

Ejemplo

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns \
-d api_token=TU_TOKEN_DE_API

POST/api/v1/campaignsCrear una campaña

Crear una campaña

Parámetros

$list_uid: List's uid
$name: New campaign name
$subject: Email subject
$from_email: From email
$from_name: From name
$reply_to: Reply-to email
$track_openOpcional: Track open (true|false)
$track_clickOpcional: Track click (true|false)
$sign_dkimOpcional: Sign dkim (true|false)
$skip_failed_messagesOpcional: Track open (true|false)
$htmlOpcional: Campaign HTML content

Devuelve

New campaign's information in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns \
-d api_token=TU_TOKEN_DE_API \
-d mail_list_uid={list_uid} \
-d name=MyCampaign \
-d subject=HelloWorld \
-d from_email=noreply@gmail.com \
-d from_name=NoReply \
-d reply_to=noreply@gmail.com \
-d track_open=true \
-d track_click=true \
-d sign_dkim=false \
-d skip_failed_messages=false \
-d html='<p>Hello!</p>'

GET/api/v1/campaigns/{uid}Ver una campaña concreta

Ver una campaña concreta

Devuelve

Campaign's information in json

Ejemplo

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid} \
-d api_token=TU_TOKEN_DE_API

PATCH/api/v1/campaigns/{uid}Actualizar una campaña

Actualizar una campaña

Parámetros

$list_uid: List's uid
$name: Campaign name
$subject: Email subject
$from_email: From email
$from_name: From name
$reply_to: Reply-to email
$track_openOpcional: Track open (true|false)
$track_clickOpcional: Track click (true|false)
$sign_dkimOpcional: Sign dkim (true|false)
$skip_failed_messagesOpcional: Track open (true|false)

Devuelve

New campaign's information in json

Ejemplo

curl -X PATCH -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid} \
-d api_token=TU_TOKEN_DE_API \
-d name=MyCampaign2 \
-d subject=HelloWorld2 \
-d sign_dkim=true

POST/api/v1/campaigns/{uid}/runLanzar una campaña

Lanzar una campaña

Devuelve

Action messages in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid}/run \
-d api_token=TU_TOKEN_DE_API

POST/api/v1/campaigns/{uid}/pausePausar una campaña

Pausar una campaña

Devuelve

Action messages in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid}/pause \
-d api_token=TU_TOKEN_DE_API

POST/api/v1/campaigns/{uid}/resumeReanudar una campaña

Reanudar una campaña

Devuelve

Action messages in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid}/resume \
-d api_token=TU_TOKEN_DE_API

DELETE/api/v1/campaigns/{uid}Borrar una campaña

Borrar una campaña

Parámetros

$uid: Campaign's uid

Devuelve

Result messages in json

Ejemplo

curl -X DELETE -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid} \
-d api_token=TU_TOKEN_DE_API

SUSCRIPTORES

GET/api/v1/subscribersVer los contactos de una lista

Ver los contactos de una lista

Parámetros

$list_uid: List's uid
$openOpcional: yes - opened some campaigns
no - not opened any campaign
$clickOpcional: yes - clicked some campaigns
no - not clicked any campaign
$per_pageOpcional: Number of subscribers per page
$page: Page number

Devuelve

List of all list's subscribers in json

Ejemplo

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers \
-d api_token=TU_TOKEN_DE_API \
-d list_uid={list_uid} \
-d per_page=20 \
-d page=1

POST/api/v1/subscribersCrear un contacto en una lista

Crear un contacto en una lista

Parámetros

$list_uid: List's uid
$EMAIL: Subscriber's email
$tagOpcional: Subscriber's tags, seperated by a comma (,).
$statusOpcional: Subscriber's status: subscribed | unsubscribed | unconfirmed
$[OTHER_FIELDS...]Opcional: All subscriber's other fields: FIRST_NAME (?), LAST_NAME (?),... (depending on the list fields configuration)

Devuelve

Creation messages in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers \
-d api_token=TU_TOKEN_DE_API \
-d list_uid={list_uid} \
-d EMAIL=test@gmail.com \
-d tag=foo,bar,tag+with+space, \
-d FIRST_NAME=Marine \
-d LAST_NAME=Joze \
-d status=subscribed

GET/api/v1/subscribers/{id}Ver un contacto concreto

Ver un contacto concreto

Parámetros

$id: Subsciber's id or email

Devuelve

All subscriber information in json

Ejemplo

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers/{id} \
-d api_token=TU_TOKEN_DE_API

PATCH/api/v1/subscribers/{id}Actualizar un contacto

Actualizar un contacto

Parámetros

$uid: Subscriber's uid
$EMAIL: Subscriber's email
$tagOpcional: Subscriber's tags, seperated by a comma (,).
$[OTHER_FIELDS...]Opcional: All subscriber's other fields: FIRST_NAME (?), LAST_NAME (?),... (depending on the list fields configuration)

Devuelve

Update messages in json

Ejemplo

curl -X PATCH -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers/{id} \
-d api_token=TU_TOKEN_DE_API \
-d EMAIL=test@gmail.com \
-d tag=foo,bar,tag+with+space, \
-d FIRST_NAME=Marine \
-d LAST_NAME=Joze \
-d status=unsubscribed

POST/api/v1/subscribers/{id}/add-tagAñadir etiquetas a un contacto

Añadir etiquetas a un contacto

Parámetros

$tagOpcional: Subscriber's tags, seperated by a comma (,).

Devuelve

Creation messages in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers/-ID-/add-tag \
-d api_token=TU_TOKEN_DE_API \
-d tag=foo,bar,tag+with+space

POST/api/v1/subscribers/{id}/remove-tagQuitar etiquetas a un contacto

Quitar etiquetas a un contacto

Parámetros

$tagOpcional: Subscriber's tags, seperated by a comma (,).

Devuelve

Update messages in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers/-ID-/remove-tag \
-d api_token=TU_TOKEN_DE_API \
-d tag=foo,bar,tag+with+space

GET/api/v1/subscribers/email/{email}Buscar contactos por correo

Buscar contactos por correo

Parámetros

$email: Subsciber's email

Devuelve

All subscribers with the email

Ejemplo

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers/email/{email} \
-d api_token=TU_TOKEN_DE_API

PATCH/api/v1/lists/{list_uid}/subscribers/{id}/subscribeSuscribir un contacto

Suscribir un contacto

Parámetros

$list_uid: List's uid
$id: Subsciber's id

Devuelve

Result messages in json

Ejemplo

curl -X PATCH -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{list_uid}/subscribers/{id}/subscribe \
-d api_token=TU_TOKEN_DE_API

PATCH/api/v1/lists/{list_uid}/subscribers/{id}/unsubscribeDar de baja un contacto

Dar de baja un contacto

Parámetros

$list_uid: List's uid
$id: Subsciber's id

Devuelve

Result messages in json

Ejemplo

curl -X PATCH -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{list_uid}/subscribers/{id}/unsubscribe \
-d api_token=TU_TOKEN_DE_API

PATCH/api/v1/lists/{list_uid}/subscribers/email/{email}/unsubscribeDar de baja un contacto

Dar de baja un contacto

Parámetros

$list_uid: List's uid
$email: Subsciber's email

Devuelve

Result messages in json

Ejemplo

curl -X PATCH -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{list_uid}/subscribers/email/{email}/unsubscribe \
-d api_token=TU_TOKEN_DE_API

DELETE/api/v1/subscribers/{id}Borrar un contacto

Borrar un contacto

Parámetros

$list_uid: List's uid
$id: Subsciber's id

Devuelve

Result messages in json

Ejemplo

curl -X DELETE -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers/{id} \
-d api_token=TU_TOKEN_DE_API

Notificación

POST/api/v1/notification/bounceAvisar de un rebote duro. Los rebotes blandos no hace falta comunicarlos

Avisar de un rebote duro. Los rebotes blandos no hace falta comunicarlos

Parámetros

$message_id: Message's id
$description: Notification message

Devuelve

Action messages in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/notification/bounce \
-d api_token=TU_TOKEN_DE_API  \
-d message_id=201637442604422402.6199642caf7f3@example.com

Bucle de feedback

POST/api/v1/notification/feedbackEnviar un rebote o una denuncia de spam: puede ser entrega correcta, rebote, feedback o denuncia

Enviar un rebote o una denuncia de spam: puede ser entrega correcta, rebote, feedback o denuncia

Parámetros

$message_id: Message's id
$type: Poassible values include: spam | abuse
$description: Notification message

Devuelve

Action messages in json

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/notification/feedback \
-d api_token=TU_TOKEN_DE_API  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=abuse

FILE

POST/api/v1/file/uploadSubir ficheros al almacenamiento del cliente

Subir ficheros al almacenamiento del cliente

Parámetros

$file_url: File url
$subdirectoryOpcional: Custom subdirectory

Devuelve

Upload result message

Ejemplo

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/file/upload \
-d api_token=TU_TOKEN_DE_API  \
-d files='[{"url":"http://example.com/images/logo_big.svg","subdirectory":"path/to/file"},{"url":"http://example.com/images/logo_big.svg","subdirectory":"path/to/file2"}]'

Estos son los 29 endpoints disponibles. Para ver los ejemplos con tu propio token, entra en tu panel.