Una api es La interfaz de programacin de aplicaciones

Comienza con la API de MailChimp

Con MailChimp API 3.0, puede sincronizar la actividad de correo electrnico y
estadsticas de la campaa con su base de datos, gestin de listas, ver y de
automatizacin, control de flujos de trabajo, y probar diferentes llamadas y los
puntos finales antes de empujar a la produccin.

Despus de leer esta gua, asegrese de revisar la referencia de API para ver todas
las solicitudes de API disponibles, y visitar la Zona de juegos para poner a prueba
las llamadas en tiempo real, con sus propios datos.

Comienza con la API de MailChimp

Aprender acerca de la API de MailChimp. Los programadores pueden utilizar
nuestra API REST para conectar MailChimp a un CMS, blog, tienda en lnea, y
mucho ms.
https://<dc>.api.mailchimp.com/3.0

La <dc>parte de la URL corresponde al centro de datos para su cuenta. Por

ejemplo, si la ltima parte de su clave de API de MailChimp es us6, todos los
puntos finales de API para su cuenta estn disponibles
enhttps://us6.api.mailchimp.com/3.0/.
Cada recurso tpicamente se separa en una resource/{id}formato, con
subresources siguiendo el mismo patrn. Por ejemplo, si usted est buscando
informacin acerca de las listas, realizar una solicitud GET
ahttps://<dc>.api.mailchimp.com/3.0/lists. Para acceder a una lista individual,
realizar una solicitud GET
a https://<dc>.api.mailchimp.com/3.0/lists/{list_id}.

Hay 2 mtodos de autenticacin para la API: autenticacin bsica HTTP y

OAuth2. La forma ms fcil de autenticar est utilizando autenticacin bsica
HTTP. Introduzca cualquier cadena como su nombre de usuario y proporcionar
su clave de API como la contrasea. Su biblioteca cliente HTTP debera haber
soporte incorporado para la autenticacin bsica, pero aqu hay un ejemplo rpido
que muestra cmo autenticar con la --useropcin de rizo :
curl --request GET \
--url 'https://<dc>.api.mailchimp.com/3.0/' \
--user 'anystring:<your_apikey>'

Mtodos HTTP

La API de MailChimp compatible con 5 mtodos HTTP para interactuar con los
recursos:
GETrealizar una solicitud GET para recuperar los datos. Peticiones GET no causarn
una actualizacin o cambio en sus datos, ya que son seguros y idempotente .
POSTALUse una solicitud POST para crear nuevos recursos. Por ejemplo, hacer una
solicitud POST a un punto final de la coleccin (como /lists), donde el cuerpo de su
solicitud JSON es una lista nueva.
PARCHEEfecte una peticin de parches para actualizar un recurso. Con las
solicitudes de conexin, slo tiene que proporcionar los datos que desea cambiar.

PONERUsar una solicitud PUT para crear o actualizar un recurso. Esto es muy til
para la sincronizacin de datos de abonado .
BORRARHaz una solicitud DELETE para eliminar un recurso.

Nota

Si su ISP no permite operaciones HTTP que no sean GET o POST, utilice un tnel
HTTP Mtodo: hacer que su llamada con POST, pero no incluyen el mtodo que
va a utilizar en un X-HTTP-Method-Override cabecera.

JSON

La API de MailChimp slo es compatible con JSON. As que en lugar de XML,

HTTP POST parmetros, u otros formatos de serializacin, la mayora de las
peticiones POST y el parche requieren un objeto JSON vlida para el
cuerpo. La referencia de la API incluye ejemplos completos, pero aqu hay un rpido
vistazo a formato JSON que estamos buscando en su puesto y solicita una ruta:
{
"name": "Freddie's Favorite Hats",
"contact": {
"company": "MailChimp",
"address1": "675 Ponce De Leon Ave NE",
"address2": "Suite 5000",
"city": "Atlanta",
"state": "GA",
"zip": "30308",
 "country": "US",
"phone": ""
},
"permission_reminder": "You're receiving this email because you signed up for updates about
Freddie's newest hats.",
"campaign_defaults": {
"from_name": "Freddie",
"from_email": "freddie@freddiehats.com",
"subject": "",
"language": "en"
},
"email_type_option": true
}

parmetros de ruta

En una URL de la API, se incluyen los nombres de recursos e identificadores

nicos para ayudar a encontrar la manera de estructurar sus peticiones. nombres
de recursos son inmutables, pero se requieren identificadores de recursos, por lo
que los va a cambiar con los valores reales de su cuenta de MailChimp. Veamos
un ejemplo:

https://usX.api.mailchimp.com/3.0/lists/{list_id}/members/{email_id}/notes/{id}
En esa URL, hay 1 recurso primario, listsy 2
subresources: membersy notes. Tambin hay 3 parmetros de ruta diferentes que
usted necesita para reemplazar los valores reales de su cuenta de
MailChimp:list_id, email_id, y id. Cuando se sustituye esos valores con los
datos reales, su URL final debe ser algo como esto:
https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08
/notes

parmetros de cadena de consulta

Utilizamos los parmetros de cadena de consulta para el filtrado, la paginacin, y

las respuestas parciales en la API de MailChimp. El formato de los parmetros de
cadena de consulta es la URL del recurso completo seguido de un signo de
interrogacin, y los parmetros opcionales:

https://usX.api.mailchimp.com/3.0/campaigns?option1=foo&option2=bar
Filtracin

La referencia de la API muestra cules son los recursos que puede filtrar, y lo que
debe incluir en su cadena de consulta URL. Por ejemplo, para ver solamente las
campaas de RSS, utilice/3.0/campaigns?type=rss
Si proporciona varios filtros, slo nos volvemos recursos que coinciden con todos
los filtros.

Paginacin

Paginate sus solicitudes de API para limitar los resultados de respuesta y hacerlos
ms fciles de trabajar. Nosotros usamos offsety counten la cadena de consulta
URL para paginar, ya que proporciona un mayor control sobre la forma de ver sus
datos.
Offsetpor defecto es 0, por lo que si se utiliza offset=1, se perder el primer
elemento en el conjunto de datos. Countpor defecto es 10. Por ejemplo, este URL
incluye parmetros de cadena de consulta para la paginacin:
https://usX.api.mailchimp.com/3.0/campaigns?offset=0&count=10

respuestas parciales

Utilice los parmetros de campo para reducir las transferencias de datos mediante
la limitacin de los campos que los rendimientos de la API de MailChimp. Por
ejemplo, puede que no necesite todos los detalles de un recurso, y en su lugar
puede pasar una lista separada por comas de los campos especficos que desee
incluir.

Los parmetros fieldsy exclude_fieldsson mutuamente excluyentes y generar

un error si un campo no es vlida en su solicitud. Por ejemplo, la siguiente URL
utiliza el fieldsparmetro de cadena de consulta slo para incluir el nombre y la
lista de la lista de campos de ID de la respuesta:
https://usX.api.mailchimp.com/3.0/lists?fields=lists.name,lists.id

Solicitud parmetros corporales

Para el parche, PUT y POST peticiones, puede que tenga que incluir un cuerpo de
solicitud en formato JSON. La API de referencia que muestra todos los parmetros
de la peticin disponibles para cada punto final, incluyendo los campos
obligatorios. El siguiente ejemplo muestra cmo crear una nueva lista con una
solicitud POST HTTP utilizando rizo (tenga en cuenta el formato de la --
dataopcin).
curl --request POST \
--url 'https://usX.api.mailchimp.com/3.0/lists' \
--user 'anystring:apikey' \
--header 'content-type: application/json' \
--data '{"name":"Freddie'\''s Favorite
Hats","contact":{"company":"MailChimp","address1":"675 Ponce De Leon Ave
NE","address2":"Suite
5000","city":"Atlanta","state":"GA","zip":"30308","country":"US","phone":""},"permissi
on_reminder":"You'\''re receiving this email because you signed up for updates about Freddie'\''s
newest
hats.","campaign_defaults":{"from_name":"Freddie","from_email":"freddie@freddi
ehats.com","subject":"","language":"en"},"email_type_option":true}' \
--include

parmetros corporales respuesta

Cada respuesta de llamada a la API incluye cabeceras y una opcional cuerpo con
formato JSON .
Nota

Eliminar solicitudes devuelven slo los encabezados sin un cuerpo JSON.

La referencia API incluye todos los posibles parmetros cuerpo de la respuesta, pero el
ejemplo siguiente se muestra el tipo de respuesta con formato JSON a esperar de una
solicitud POST al /listspunto final:
{
"id": "1510500e0b",
"name": "Freddies Favorite Hats",
"contact": {
"company": "MailChimp",
"address1": "675 Ponce De Leon Ave NE",
"address2": "Suite 5000",
"city": "Atlanta",
"state": "GA",
"zip": "30308",
"country": "US",
"phone": ""
},
 "permission_reminder": "",
"use_archive_bar": true,
"campaign_defaults": {
"from_name": "Freddie",
"from_email": "freddie@freddiehats.com",
"subject": "",
"language": "en"
},
"notify_on_subscribe": "",
"notify_on_unsubscribe": "",
"date_created": "2015-09-16T14:55:51+00:00",
"list_rating": 0,
"email_type_option": true,
"subscribe_url_short": "http://eepurl.com/xxxx",
"subscribe_url_long": "http://freddieshats.usX.list-
manage.com/subscribe?u=8d3a3db4d97663a9074efcc16&id=1510500e0b",
"beamer_address": "usX-xxxx-xxxx@inbound.mailchimp.com",
"visibility": "pub",
"modules": [],
"stats": {
"member_count": 0,
"unsubscribe_count": 0,
"cleaned_count": 0,
"member_count_since_send": 0,
"unsubscribe_count_since_send": 0,
"cleaned_count_since_send": 0,
"campaign_count": 0,
"campaign_last_sent": "",
"merge_field_count": 2,
"avg_sub_rate": 0,
"avg_unsub_rate": 0,
"target_sub_rate": 0,
"open_rate": 0,
"click_rate": 0,
"last_sub_date": "",
"last_unsub_date": ""
},
"_links": [
{
"rel": "self",
"href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b" ,
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
},
{
 "rel": "parent",
"href": "https://usX.api.mailchimp.com/3.0/lists",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Collection.json" ,
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists.json"
},
{
"rel": "update",
"href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b" ,
"method": "PATCH",
"schema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
},
{
"rel": "delete",
"href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b" ,
"method": "DELETE"
},
{
"rel": "abuse-reports",
"href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/abuse-reports",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Abuse/Collection.json" ,
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Abuse.json"
},
{
"rel": "activity",
"href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/activity" ,
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Activity/Collection.json"
},
{
"rel": "clients",
"href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/clients" ,
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Clients/Collection.json"
},
{
"rel": "growth-history",
"href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/growth-history",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Growth/Collection.json" ,
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Growth.json"
},
{
"rel": "interest-categories",
 "href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/interest-categories",
"method": "GET",
"targetSchema":
"https://api.mailchimp.com/schema/3.0/Lists/InterestCategories/Collection.json" ,
"schema":
"https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/InterestCategories.json"
},
{
"rel": "members",
"href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/members" ,
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Collection.json" ,
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
},
{
"rel": "merge-fields",
"href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/merge-fields",
"method": "GET",
"targetSchema":
"https://api.mailchimp.com/schema/3.0/Lists/MergeFields/Collection.json" ,
"schema":
"https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/MergeFields.json"
},
{
"rel": "segments",
"href": "https://usX.api.mailchimp.com/3.0/lists/1510500e0b/segments" ,
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Segments/Collection.json",
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Segments.json"
}
]
}

Ejemplos de cdigo

A lo largo de la documentacin de la API de MailChimp, incluimos ejemplos de cdigo

para que sepa cmo dar formato a sus peticiones, y qu tipo de datos que se puede esperar a
cambio.

Utilizamos rizo para mostrar todas las solicitudes. Por ejemplo, el fragmento de cdigo
siguiente muestra una solicitud POST al /listspunto final:
curl --request POST \
--url 'https://usX.api.mailchimp.com/3.0/lists' \
--user 'anystring:apikey' \
--header 'content-type: application/json' \
--data '{"name":"Freddie'\''s Favorite
Hats","contact":{"company":"MailChimp","address1":"675 Ponce De Leon Ave
NE","address2":"Suite
5000","city":"Atlanta","state":"GA","zip":"30308","country":"US","phone":""},"permissi
on_reminder":"You'\''re receiving this email because you signed up for updates about Freddie'\''s
newest
hats.","campaign_defaults":{"from_name":"Freddie","from_email":"freddie@freddi
ehats.com","subject":"","language":"en"},"email_type_option":true}' \
--include
Para la mayora de las solicitudes de ejemplo, podemos utilizar el mismo conjunto
de comandos rizo :
solicitarel tipo de peticin HTTP para hacer, uno de POST, GET, PARCHE, DELETE
o PUT.

urlLa URL de la API para solicitar.

de usuarioDefine el nombre de usuario y la contrasea para la autenticacin con el

API 3.0. Utilizar cualquier cadena como el nombre de usuario (antes de los dos
puntos), pero debe incluir su clave API de MailChimp como la contrasea (despus de
los dos puntos).

datos desolicitud cuerpo El JSON-formateado. Se requiere para la mayora de las

peticiones POST, parches y PUT.

incluirYa sea para mostrar las cabeceras HTTP en la respuesta. Utilice esta opcin si
acaba de empezar con la API o la solucin de problemas, ya que devuelven
informacin de error, tanto en las cabeceras HTTP (como un cdigo de estado HTTP)
y el cuerpo.

Usamos la, forma larga de doble tablero de opciones de enrollamiento para facilitar la
lectura, pero le invitamos a usar la forma corta, de un solo tablero, si lo prefiere.

Para mostrar las respuestas de ejemplo, incluimos un objeto JSON en agradable para la
impresin de formato. Por ejemplo, he aqu una respuesta a una solicitud GET para el punto
final de la raz de la API 3.0:
{
"account_id": "8d3a3db4d97663a9074efcc16",
"account_name": "Freddies Jokes",
"contact": {
"company": "Freddies Jokes",
"addr1": "675 Ponce De Leon Ave NE",
"addr2": "Suite 5000",
"city": "Atlanta",
 "state": "GA",
"zip": "30308",
"country": "US"
},
"last_login": "2015-09-15 14:25:37",
"total_subscribers": 413,
"_links": [
{
"rel": "self",
"href": "https://usX.api.mailchimp.com/3.0/" ,
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Root.json"
},
{
"rel": "lists",
"href": "https://usX.api.mailchimp.com/3.0/lists",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Collection.json",
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists.json"
},
{
"rel": "reports",
"href": "https://usX.api.mailchimp.com/3.0/reports" ,
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/Collection.json" ,
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Reports.json"
},
{
"rel": "conversations",
"href": "https://usX.api.mailchimp.com/3.0/conversations" ,
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Conversations/Collection.json" ,
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Conversations.json"
},
{
"rel": "campaigns",
"href": "https://usX.api.mailchimp.com/3.0/campaigns" ,
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Collection.json" ,
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Campaigns.json"
},
{
"rel": "automations",
"href": "https://usX.api.mailchimp.com/3.0/automations" ,
"method": "GET",
 "targetSchema": "https://api.mailchimp.com/schema/3.0/Automations/Collection.json" ,
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Automations.json"
},
{
"rel": "templates",
"href": "https://usX.api.mailchimp.com/3.0/templates" ,
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Templates/Collection.json" ,
"schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Templates.json"
},
{
"rel": "file-manager",
"href": "https://usX.api.mailchimp.com/3.0/file-manager",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/FileManager/Namespace.json"
},
{
"rel": "authorized-apps",
"href": "https://usX.api.mailchimp.com/3.0/authorized-apps",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/AuthorizedApps/Collection.json"
}
]
}

JSON esquema

Exponemos pblicamente disponibles esquema JSON documentos para la API de

MailChimp. Utilice los archivos de esquema para generar la documentacin, las bibliotecas
de derivadores, o simplemente navegar manualmente
visitando https://api.mailchimp.com/schema/3.0/Root.json o el patio .
La siguiente lista describe cada una de las partes pertinentes de un archivo de esquema.

La schemapropiedad une al esquema que describe los datos que debe enviar.
La targetSchemapropiedad describe lo que se vuelve a encender una solicitud
exitosa.
Para los enlaces GET, el esquema se describe cmo crear una cadena de consulta.

Para el post, parches y poner enlaces, los esquemas describen el objeto JSON que debe
enviar.

Archivos de esquema tambin incluyen una _linksseccin que puede ayudarle a

navegar de un recurso a otro y mostrar las acciones disponibles.
errores
Exponemos los errores de la API de dos maneras: los cdigos de respuesta HTTP estndar y
mensajes legibles en formato JSON. Por ejemplo, el siguiente fragmento de cdigo muestra
un error HTTP 405 en los encabezados de respuesta:

HTTP/1.1 405 Method Not Allowed

Server: nginx
Content-Type: application/problem+json; charset=utf-8
Content-Length: 253
X-Request-Id: a1efb240-f8d8-40fe-a680-c3a5619a42e9
Link: <https://us2.api.mailchimp.com/schema/3.0/ProblemDetailDocument.json>;
rel="describedBy"
Date: Thu, 17 Sep 2015 19:02:28 GMT
Connection: keep-alive
Set-Cookie: _AVESTA_ENVIRONMENT=prod; path=/
Y este fragmento muestra el error humano legible como un objeto JSON:

{"type":"http://kb.mailchimp.com/api/error-docs/405-method-not-allowed","title":"Method Not
Allowed","status":405,"detail":"The requested method and resource are not compatible. See the
Allow header for this resource's available methods.","instance":""}
Para los cdigos de respuesta HTTP, cdigos 4xx sugieren una solicitud incorrecta. Si
recibe una respuesta 4xx, se recomienda revisar el glosario de error de ms contexto para
ayudar a solucionar problemas. Errores 5xx indican un problema en el extremo de
MailChimp, por lo que si recibe un error 5xx, se recomienda
comprobar @MailChimpStatus y @MailChimp_API en Twitter para ver si estamos
experimentando cualquier problema de todo el sistema.
De lo contrario, le invitamos a ponerse en contacto con nuestro equipo de soporte . Si se
comunica con el apoyo, se recomienda incluir la solicitud completa que est tratando de
hacer y el cdigo de error y la respuesta que est recibiendo para que puedan ayudar lo ms
rpidamente posible.

Prueba de control de errores

Para probar el manejo de errores, errores desencadenar s mismo mediante el envo de un X-

Trigger-Errorencabezado con el nombre del error para disparar. Por ejemplo,
desencadenar un error 401 mediante el envo de un valor de 'APIKeyMissing' en el X-
Trigger-Errorencabezado.
Si un error devuelve cdigo HTML en lugar de JSON, su solicitud puede haber
expirado. Pngase en contacto con nuestro equipo de soporte , y la nota de la Ref#dentro
del error.
estrangulacin
Para mejorar las conexiones y experiencias para todos nuestros usuarios, utilizamos algunos
lmites de conexin cuando vemos otra actividad sospechosa o sobrecarga. Cada cuenta de
usuario se permite hasta 10 conexiones simultneas, y recibirs un mensaje de error si se
alcanza el lmite. No del acelerador basado en volumen.

Antes de que empieces

Para utilizar las operaciones por lotes en la API de MailChimp, slo tiene que saber cmo
hacer llamadas bsicas de la API . Esta gua no se basa en ningn idioma o biblioteca
especfica.
Hacer una solicitud operaciones por lotes

La solicitud de realizar para llevar a cabo una operacin por lotes es una lista de las
llamadas a la API. Para obtener ms informacin sobre cmo hacer la solicitud, ver
la solicitud de esquema .
{
"operations": [
{
"method": "GET", # The http verb for the operation
"path": "/campaigns", # The relative path of the operation
"operation_id": "my-id", # A string you provide that identifies the operation
"params": {...}, # Any URL params, only used for GET
"body": "{...}" # The JSON payload for PUT, POST, or PATCH
},
]
}
Para activar el procesamiento de una solicitud de operaciones por lotes, la solicitud
a /3.0/batches. Como siempre que la solicitud se ajusta a este formato, recibir una
respuesta 200 y se devolver un nuevo recurso operacin por lotes.
{
"id": "123abc", # Unique id of the batch call
"status": "pending", # Status for the whole call
# Pending, preprocessing, started, finalizing, or
finished
"total_operations": 1, # Number of operations in the batch
"finished_operations": 1, # Number of finished operations
"errored_operations": 0, # Number of errored operations
"submitted_at": "...", # Datetime the call was made
"completed_at": "...", # Datetime when all the operations completed
 "response_body_url": "...", # URL to use to retrieve results
}
Aqu hay algunas cosas a tener en cuenta al realizar las solicitudes de operacin por lotes:

Las operaciones en una solicitud no estn garantizados para funcionar en orden.

Peticiones GET que no incluyen un countparmetro de pgina automticamente a

travs de toda la coleccin. Esto puede ser til para recuperar una coleccin entera,
pero puede tomar un largo tiempo para procesar.
Nota

El operation_idparmetro de la peticin por lotes es opcional y puede ser cualquier

cadena. Lo mismo operation_idque se proporciona en la solicitud se devuelve con los
resultados sin cambios.
Esto significa que puede coincidir con un conjunto de resultados de una operacin
especfica en la solicitud original, por lo que recomendamos el uso de un valor nico y
significativo para operation_id.
Comprobar el estado de una operacin por lotes
Para recuperar el estado de una operacin por lotes que ya ha solicitado, realizar una
llamada GET para batches/{id}que el ides la cadena que se devuelve cuando se solicit
originalmente la operacin por lotes. Para una descripcin de todos los campos de la
respuesta, ver el esquema de recursos . Realizar una llamada GET
para /3.0/batchesobtener una lista de las operaciones por lotes solicitado en los ltimos 7
das.
El recurso por lotes que se devuelve incluir estos indicadores de estado para operaciones
recientes:

en espera deprocesamiento en la operacin por lotes no ha comenzado todava.

preprocesamientoLa solicitud de lote est siendo disuelta en operaciones ms

pequeas para acelerar el procesamiento.

iniciadoProcessing ha comenzado.

La finalizacinde procesamiento se ha completado, pero los resultados estn siendo

compilado y guardado.

terminadoprocesamiento se realiza. Ahora es posible recuperar los resultados de la

URL que aparece en response_body_url.
total_operationsEl nmero total de operaciones para ser procesada.

finished_operationsEl nmero de operaciones que han procesados.

 errored_operationsEl nmero de operaciones que han devuelto una respuesta no-200.

Obtener los resultados de una operacin por lotes

Cuando se haya completado el procesamiento, obtener los resultados de las operaciones

realizadas. Para operaciones por lotes que constan nicamente de las operaciones de la
POST o parche, como la adicin de suscriptores a una lista, no es necesario recuperar los
resultados.

Una llamada GET a la URL devuelto en los recursos lotes response_body_urldevuelve un

archivo tar comprimido con gzip de archivos JSON que contienen los resultados de las
operaciones en el siguiente formato:
[
{
"status_code": 200,
"operation_id": "my-id",
"response": "{...}"
},...
]
Nota

Por razones de seguridad, response_body_urlslo es vlida durante 10 minutos. Despus

de 10 minutos, generar otro con una llamada GET a /3.0/batches/{id}.
Despus de realizar la solicitud de la operacin por lotes, los resultados estn disponibles
durante 7 das.

WebHooks lotes

Configurar un web hook lote para evitar la necesidad de comprobar peridicamente sobre
estados de proceso por lotes. Una web hook le permite especificar una direccin URL que
va a recibir datos POST de MailChimp una vez que se ha completado un proceso por lotes.

Para configurar WebHooks por lotes, utilice el lote WebHooks punto final de la
API. Vamos a validar cualquier URL web hook haciendo una peticin GET a la direccin
proporcionada con el fin de asegurarse de que es vlida, as que asegrese de que la URL
puede aceptar tanto peticiones GET y POST.
Una vez que se ha configurado un web hook lotes, MailChimp enviar informacin sobre
las operaciones por lotes completos a la URL de su web hook en un cuerpo de POST de
pares clave / valor. Este cuerpo de POST incluir el mismo response_body_urlque se
devuelve en la respuesta del GET / lotes / {} batch_id , junto con alguna informacin
adicional. Use este response_body_urlpara descargar el archivo tar comprimido con
gzip como normal, pero por favor tenga en cuenta que se aplica el mismo perodo de
caducidad de 10 minutos. Despus de 10 minutos, se puede generar
otro reponse_body_urlcon una llamada GET a /3.0/batches/{id}.

Lote de datos de ejemplo web hook

"data[_links][0][href]": "https://usX.api.mailchimp.com/3.0/batches"
"data[_links][0][method]": "GET"
"data[_links][0][rel]": "parent"
"data[_links][0][schema]":
"https://usX.api.mailchimp.com/schema/3.0/CollectionLinks/Batches.json"
"data[_links][0][targetSchema]":
"https://usX.api.mailchimp.com/schema/3.0/Definitions/Batches/CollectionResponse.json"
"data[_links][1][href]": "https://usX.api.mailchimp.com/3.0/batches/1234ab56cd"
"data[_links][1][method]": "GET"
"data[_links][1][rel]": "self"
"data[_links][1][targetSchema]":
"https://usX.api.mailchimp.com/schema/3.0/Definitions/Batches/Response.json"
"data[_links][2][href]": "https://usX.api.mailchimp.com/3.0/batches/1234ab56cd"
"data[_links][2][method]": "DELETE"
"data[_links][2][rel]": "delete"
"data[completed_at]": "2017-02-10T14:44:22+00:00"
"data[errored_operations]": "0"
"data[finished_operations]": "1"
"data[id]": "1234ab56cd"
"data[response_body_url]": "https://mailchimp-api-batch.s3.amazonaws.com/1234ab56cd-
response.tar.gz?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Expires=1486739377&Si
gnature=xxxxxxxxxxxxxxxxxxxxxxxxxxxx%3D"
"data[status]": "finished"
"data[submitted_at]": "2017-02-10T14:44:14+00:00"
"data[total_operations]": "1"
"fired_at": "2017-02-10 14:59:37"
"type": "batch_operation_completed"

API de exportacin
Nuestro API de exportacin ofrece a los clientes una manera de acceder a grandes conjuntos
de datos que de otra manera sera difcil o lento para recuperar la API 3.0. La API de
exportacin le permite obtener la lista de informacin y suscriptor Actividad rpidamente,
aunque no admite el filtrado, clasificacin, o bsqueda de los resultados como API 3.0.
Aadir un sitio y Parmetros
El punto final API de exportacin es el centro de datos especfico, al igual que la API 3.0
puntos finales .
El formato genrico para el punto final de la API es:

https://<dc>.api.mailchimp.com/export/1.0/
La <dc>parte de la URL corresponde al centro de datos para su cuenta. Por ejemplo, si la
ltima parte de su clave de API de MailChimp es us6, todos los puntos finales de API para
su cuenta estn disponibles en https://us6.api.mailchimp.com/export/1.0.

formatos de salida

Actualmente, el nico formato de salida soportado es JSON streaming. Esto significa que
una llamada a esta API no devolver un solo objeto JSON vlida, sino ms bien una serie de
objetos JSON vlidos separados por caracteres de nueva lnea.

Si bien esto puede parecer contrario a la intuicin en un primer momento, el formato se

adapta mejor a grandes conjuntos de datos que un solo objeto JSON sera. En lugar de tener
que recibir y procesar toda la respuesta (que podra ser muchos megabytes de datos) y la
generacin de un objeto JSON igualmente grande para trabajar con, cada elemento puede
ser operado inmediatamente. Esto permite a su aplicacin para realizar las acciones
deseadas en el detalle, luego descartar los datos, manteniendo la huella de memoria de su
aplicacin baja.

HTTPS / conexiones seguras

Le damos un certificado vlido, firmado por todos los mtodos de la API. Si va a codificar
manualmente enviar URL, cambiar http a https en la URL, y asegrese de que su biblioteca
de conexin soporta HTTPS.

lista de exportacin
Exportaciones de los miembros de una lista y todos los detalles de sus asociados. Esta es
una muy similar a la exportacin a travs de la interfaz web.

URL completa:

https://<dc>.api.mailchimp.com/export/1.0/list/
Parmetros de la peticin:

Parmetro Descripcin

apikey una clave de API vlida para su cuenta de usuario.

id la lista de identificacin para recibir los miembros de

status opcional - el estado para que los miembros de - uno de (,, limpiadas no suscritas suscritos) por
defecto, al suscrito

segment opcional - Tire solamente de un cierto segmento de su lista.

since opcional - nico miembro cuyos datos ha cambiado desde una fecha y hora GMT volver - en
AAAA-MM-DD HH: MM: SS

hashed opcional - si, en lugar de los datos de la lista completa, prefiere una lista de direcciones de corr
electrnico hash, ajuste este parmetro en el algoritmo de hash que esperas. Actualmente, slo
sha256 es compatible.

Devoluciones:

Parmetro Descripcin

text un vertedero de texto plano de objetos JSON. La primera fila es una fila de encabezado. Cada
adicional devuelto es un objeto JSON individual. Las filas estn delimitados mediante una nue
lnea (\ n) marcador, por lo que las implementaciones pueden leer en una sola lnea a la vez,
Parmetro Descripcin

manejarlo, y seguir adelante.

Actividad Exportadora suscriptor

Exporta todas Actividad de abonado para la campaa solicitado.

URL completa:

https://<dc>.api.mailchimp.com/export/1.0/campaignSubscriberActivity/

Parmetros de la peticin:

Parmetro Descripcin

apikey una clave de API vlida para su cuenta de usuario.

id el ID de campaa para conseguir que la actividad del suscriptor

include_empty opcional - Si se establece en true un registro para cada direccin de correo electrnico
enviado a ser devuelto incluso si no hay datos de actividad. por defecto es falsa

since opcional - nica actividad registrada desde una fecha y hora GMT volver - en AAAA-MM-
DD HH: MM: SS

Devoluciones:

Parmetro Descripcin
Parmetro Descripcin

text un vertedero de texto plano de objetos JSON. La primera fila es una fila de encabezado. Cada
adicional devuelto es un objeto JSON individual. Las filas estn delimitados mediante una nue
lnea (\ n) marcador, por lo que las implementaciones pueden leer en una sola lnea a la vez,
manejarlo, y seguir adelante.

Overview
Quickly review all available resources for MailChimp API 3.0 with this reference overview.

Learn the basics of the MailChimp API in our Getting Started guide, or explore the API
with your own data in the Playground.

API Root

HTTP method Endpoint Function

GET / API Root

Authorized Apps

HTTP method Endpoint Function

POST /authorized-apps Link your application

GET /authorized-apps Get a list of authorized apps

GET /authorized-apps/{app_id} Get information about a specific authorized app

Automations

HTTP Endpoint Functio

method

GET /automations Get a l

Automa

GET /automations/{workflow_id} Get

informa
about
specific
Automa
workflo

POST /automations/{workflow_id}/actions/pause-all-emails Pause

emails
Automa
workflo

POST /automations/{workflow_id}/actions/start-all-emails Start

emails
Automa
workflo
GET /automations/{workflow_id}/emails Get a l
automat
emails
workflo

GET /automations/{workflow_id}/emails/{workflow_email_id} Get

informa
about
specific
workflo
email

POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause Pause

automat
email

POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/start Start

automat
email

POST /automations/{workflow_id}/emails/{workflow_email_id}/queue Add

subscrib
a work
email

GET /automations/{workflow_id}/emails/{workflow_email_id}/queue View

queued
subscrib
for
automat
email

GET /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash} View

specific
subscrib
 email q

POST /automations/{workflow_id}/removed-subscribers Remove

subscrib
from
workflo

GET /automations/{workflow_id}/removed-subscribers View

subscrib
remove
from
workflo

Batch Operations

HTTP method Endpoint Function

POST /batches Start a batch operation

GET /batches Get a list of batch requests

GET /batches/{batch_id} Get the status of a batch operation request

DELETE /batches/{batch_id} Delete a batch request and stop if from processing further.

Batch Webhooks

HTTP method Endpoint Function

POST /batch-webhooks Configure a webhook for batches

GET /batch-webhooks Get a list of all webhooks configured for batc

GET /batch-webhooks/{batch_webhook_id} Get a batch webook

PATCH /batch-webhooks/{batch_webhook_id} Update a webhook for batches

DELETE /batch-webhooks/{batch_webhook_id} Delete a batch webhook

Campaign Folders

HTTP method Endpoint Function

POST /campaign-folders Create campaign folder

GET /campaign-folders Get all campaign folders

GET /campaign-folders/{folder_id} Get a specific campaign folder

PATCH /campaign-folders/{folder_id} Update a campaign folder

DELETE /campaign-folders/{folder_id} Delete a campaign folder

Campaigns

HTTP method Endpoint Function

POST /campaigns Create a new campaign

GET /campaigns Get all campaigns

GET /campaigns/{campaign_id} Get information about a spec

campaign

PATCH /campaigns/{campaign_id} Update the settings for a campai

DELETE /campaigns/{campaign_id} Delete a campaign

POST /campaigns/{campaign_id}/actions/cancel-send Cancel a campaign

POST /campaigns/{campaign_id}/actions/pause Pause an RSS-Driven campaign

POST /campaigns/{campaign_id}/actions/replicate Replicate a campaign

POST /campaigns/{campaign_id}/actions/resume Resume an RSS-Driven campai

POST /campaigns/{campaign_id}/actions/schedule Schedule a campaign

POST /campaigns/{campaign_id}/actions/send Send a campaign

POST /campaigns/{campaign_id}/actions/test Send a test email

POST /campaigns/{campaign_id}/actions/unschedule Unschedule a campaign

GET /campaigns/{campaign_id}/content Get campaign content

PUT /campaigns/{campaign_id}/content Set campaign content

POST /campaigns/{campaign_id}/feedback Add campaign feedback

GET /campaigns/{campaign_id}/feedback Get feedback about a campaign

GET /campaigns/{campaign_id}/feedback/{feedback_id} Get a specific feedback message

PATCH /campaigns/{campaign_id}/feedback/{feedback_id} Update a campaign feedb

message

DELETE /campaigns/{campaign_id}/feedback/{feedback_id} Delete a campaign feedb

message

GET /campaigns/{campaign_id}/send-checklist Get the send checklist for

campaign

Conversations

HTTP method Endpoint Function

GET /conversations Get a list of conversations

GET /conversations/{conversation_id} Get information about

conversation

POST /conversations/{conversation_id}/messages Post a new conversa

message

GET /conversations/{conversation_id}/messages Get conversation message

GET /conversations/{conversation_id}/messages/{message_id} Get a specific conversa

message

E-commerce Stores

HTTP method Endpoint Function

POST /ecommerce/stores Add a n

store

GET /ecommerce/stores Get

informati
about
stores

GET /ecommerce/stores/{store_id} Get

informati
about
specific
store
PATCH /ecommerce/stores/{store_id} Update
store

DELETE /ecommerce/stores/{store_id} Delete

store

POST /ecommerce/stores/{store_id}/carts Add a n

cart to
store

GET /ecommerce/stores/{store_id}/carts Get

informati
about
stores ca

GET /ecommerce/stores/{store_id}/carts/{cart_id} Get

informati
about
specific c

PATCH /ecommerce/stores/{store_id}/carts/{cart_id} Update

specific c

DELETE /ecommerce/stores/{store_id}/carts/{cart_id} Delete a c

POST /ecommerce/stores/{store_id}/carts/{cart_id}/lines Add a n

line item
an exis
cart

GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines Get

informati
 about
carts
items

GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} Get

informati
about
specific
line item

PATCH /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} Update

specific
line item

DELETE /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} Delete

specific
line item

POST /ecommerce/stores/{store_id}/customers Add a n

customer
a store

GET /ecommerce/stores/{store_id}/customers Get

informati
about
stores
customer

GET /ecommerce/stores/{store_id}/customers/{customer_id} Get

informati
about
specific
customer
PATCH /ecommerce/stores/{store_id}/customers/{customer_id} Update
customer

PUT /ecommerce/stores/{store_id}/customers/{customer_id} Add

update
customer

DELETE /ecommerce/stores/{store_id}/customers/{customer_id} Delete

customer

POST /ecommerce/stores/{store_id}/orders Add a n

order to
store

GET /ecommerce/stores/{store_id}/orders Get

informati
about
stores
orders

GET /ecommerce/stores/{store_id}/orders/{order_id} Get

informati
about
specific
order

PATCH /ecommerce/stores/{store_id}/orders/{order_id} Update

specific
order

DELETE /ecommerce/stores/{store_id}/orders/{order_id} Delete

order
POST /ecommerce/stores/{store_id}/orders/{order_id}/lines Add a n
line item
an exis
order

GET /ecommerce/stores/{store_id}/orders/{order_id}/lines Get

informati
about
orders
items.

GET /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} Get

informati
about
specific
order
item

PATCH /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} Update

specific
order
item

DELETE /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} Delete

specific
order
item

POST /ecommerce/stores/{store_id}/products Add a n

product t
store

GET /ecommerce/stores/{store_id}/products Get

informati
about
stores
 products.

GET /ecommerce/stores/{store_id}/products/{product_id} Get

informati
about
specific
product

PATCH /ecommerce/stores/{store_id}/products/{product_id} Update

specific
product

DELETE /ecommerce/stores/{store_id}/products/{product_id} Delete

product

POST /ecommerce/stores/{store_id}/products/{product_id}/images Add a n

image to
product.

GET /ecommerce/stores/{store_id}/products/{product_id}/images Get

informati
about
products
images.

GET /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} Get

informati
about
specific
product
image

PATCH /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} Update

product
 image

DELETE /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} Delete

product
image

POST /ecommerce/stores/{store_id}/products/{product_id}/variants Add a n

variant
the produ

GET /ecommerce/stores/{store_id}/products/{product_id}/variants Get

informati
about
products
variants.

GET /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} Get

informati
about
specific
product
variant

PATCH /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} Update

product
variant

PUT /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} Add

update
product
variant

DELETE /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} Delete

product
 variant

File Manager Files

HTTP method Endpoint Function

POST /file-manager/files Upload a new file

GET /file-manager/files Get information about stored files

GET /file-manager/files/{file_id} Get a specific file

PATCH /file-manager/files/{file_id} Update a specific file

DELETE /file-manager/files/{file_id} Remove a specific file

File Manager Folders

HTTP method Endpoint Function

POST /file-manager/folders Create a new folder

GET /file-manager/folders Get a list of folders in the File Manager

GET /file-manager/folders/{folder_id} Get information about a specific folder

PATCH /file-manager/folders/{folder_id} Update a File Manager folder

DELETE /file-manager/folders/{folder_id} Remove a File Manager folder

Lists

HTTP method Endpoint Function

POST /lists Create a new li

GET /lists Get informa

about all lists

POST /lists/{list_id} Batch sub/un

list members

GET /lists/{list_id} Get informa

about a spec
list

PATCH /lists/{list_id} Update a spec

list

DELETE /lists/{list_id} Delete a list

GET /lists/{list_id}/abuse-reports Get informa

about ab
reports
GET /lists/{list_id}/abuse-reports/{report_id} Get details abo
specific ab
report

GET /lists/{list_id}/activity Get recent

activity

GET /lists/{list_id}/clients Get top em

clients

GET /lists/{list_id}/growth-history Get list gro

history data

GET /lists/{list_id}/growth-history/{month} Get list gro

history by mon

POST /lists/{list_id}/interest-categories Create a

interest categor

GET /lists/{list_id}/interest-categories Get informa

about a li
interest categor

GET /lists/{list_id}/interest-categories/{interest_category_id} Get informa

about a spec
interest categor

PATCH /lists/{list_id}/interest-categories/{interest_category_id} Update a spec

interest categor
DELETE /lists/{list_id}/interest-categories/{interest_category_id} Delete a spec
interest categor

POST /lists/{list_id}/interest-categories/{interest_category_id}/interests Create a

interest in
specific catego

GET /lists/{list_id}/interest-categories/{interest_category_id}/interests Get all interest

a spec
category

GET /lists/{list_id}/interest- Get interests i

categories/{interest_category_id}/interests/{interest_id} specific catego

PATCH /lists/{list_id}/interest- Update inter

categories/{interest_category_id}/interests/{interest_id} in a spec
category

DELETE /lists/{list_id}/interest- Delete interest

categories/{interest_category_id}/interests/{interest_id} a spec
category

GET /lists/{list_id}/locations Get list locatio

POST /lists/{list_id}/members Add a new

member

GET /lists/{list_id}/members Get informa

about member
a list
GET /lists/{list_id}/members/{subscriber_hash} Get informa
about a spec
list member

PATCH /lists/{list_id}/members/{subscriber_hash} Update a

member

PUT /lists/{list_id}/members/{subscriber_hash} Add or updat

list member

DELETE /lists/{list_id}/members/{subscriber_hash} Remove a

member

GET /lists/{list_id}/members/{subscriber_hash}/activity Get recent

member activit

GET /lists/{list_id}/members/{subscriber_hash}/goals Get the last

Goal events fo
member on
specific list

POST /lists/{list_id}/members/{subscriber_hash}/notes Add a new not

GET /lists/{list_id}/members/{subscriber_hash}/notes Get recent n

for a specific
member

GET /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} Get a specific n

for a specific
member
PATCH /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} Update a note

DELETE /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} Delete a note

POST /lists/{list_id}/merge-fields Add a new me

field

GET /lists/{list_id}/merge-fields Get all me

fields for a list

GET /lists/{list_id}/merge-fields/{merge_id} Get a spec

merge field

PATCH /lists/{list_id}/merge-fields/{merge_id} Update a me

field

DELETE /lists/{list_id}/merge-fields/{merge_id} Delete a me

field

POST /lists/{list_id}/segments Create a

segment

GET /lists/{list_id}/segments Get informa

about all segm
in a list

POST /lists/{list_id}/segments/{segment_id} Batch add/rem

list members
static segment
GET /lists/{list_id}/segments/{segment_id} Get informa
about a spec
segment

PATCH /lists/{list_id}/segments/{segment_id} Update a segm

DELETE /lists/{list_id}/segments/{segment_id} Delete a segme

POST /lists/{list_id}/segments/{segment_id}/members Add a membe

a static segmen

GET /lists/{list_id}/segments/{segment_id}/members Get informa

about all mem
in a list segmen

DELETE /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash} Remove

member from
specified st
segment

POST /lists/{list_id}/signup-forms Customize

signup f
settings for
specific list

GET /lists/{list_id}/signup-forms Get signup fo

for a specific li

POST /lists/{list_id}/webhooks Create a

webhook
GET /lists/{list_id}/webhooks Get informa
about
webhooks for
specific list

GET /lists/{list_id}/webhooks/{webhook_id} Get informa

about a spec
webhook

PATCH /lists/{list_id}/webhooks/{webhook_id} Update

webhook

DELETE /lists/{list_id}/webhooks/{webhook_id} Delete a webho

Reports

HTTP method Endpoint Function

GET /reports Get campaign reports

GET /reports/{campaign_id} Get a specific campa

report

GET /reports/{campaign_id}/abuse-reports Get abuse complaints

a campaign

GET /reports/{campaign_id}/abuse-reports/{report_id} Get information abou

specific abuse report
GET /reports/{campaign_id}/advice Get campaign feedbac

GET /reports/{campaign_id}/click-details Get campaign c

details

GET /reports/{campaign_id}/click-details/{link_id} Get click details fo

specific link

GET /reports/{campaign_id}/click-details/{link_id}/members Get information ab

subscribers who clicke
link

GET /reports/{campaign_id}/click- Get information abou

details/{link_id}/members/{subscriber_hash} specific subscriber w
clicked a link

GET /reports/{campaign_id}/domain-performance Get domain performa

stats

GET /reports/{campaign_id}/eepurl Get Eepurl activity

GET /reports/{campaign_id}/email-activity Get email activity

GET /reports/{campaign_id}/email-activity/{subscriber_hash} Get email activity fo

specific subscriber

GET /reports/{campaign_id}/locations Get top open locations

GET /reports/{campaign_id}/sent-to Get information ab
campaign recipients

GET /reports/{campaign_id}/sent-to/{subscriber_hash} Get information abou

specific campa
recipient

GET /reports/{campaign_id}/sub-reports Get reports for c

campaigns

GET /reports/{campaign_id}/unsubscribed Get unsubscribed

members

GET /reports/{campaign_id}/unsubscribed/{subscriber_hash} Get information abou

specific list member w
unsubscribed

Search Campaigns

HTTP method Endpoint Function

GET /search-campaigns Search Campaigns

Search Members

HTTP method Endpoint Function

GET /search-members Search Members

Template Folders

HTTP method Endpoint Function

POST /template-folders Create a template folder

GET /template-folders Get all template folders

GET /template-folders/{folder_id} Get a template folder

PATCH /template-folders/{folder_id} Update a template folder

DELETE /template-folders/{folder_id} Delete a template folder

Templates

HTTP method Endpoint Function

POST /templates Create a new template

GET /templates Get all templates

GET /templates/{template_id} Get information about a specific template

PATCH /templates/{template_id} Update an existing template

DELETE /templates/{template_id} Delete a specific template

GET /templates/{template_id}/default-content Get the default content for a template

Sengrid
SendGrid general
Cul es SendGrid?
SendGrid es una basada en la nube proveedor de SMTP que le permite enviar
correo electrnico sin tener que mantener servidores de correo
electrnico. SendGrid gestiona todos los detalles tcnicos, a partir de la
ampliacin de la infraestructura de alcance ISP y el seguimiento a los servicios
de reputacin de lista blanca y anlisis en tiempo real.

Nuestro objetivo es hacer que sea lo ms fcil posible para agregar correo
electrnico fiable, escalable a su aplicacin para que pueda centrarse en la
construccin de las principales caractersticas de su producto.

Quin est SendGrid para?

SendGrid es para cualquier persona que necesite enviar correo electrnico, ya
sea por correo electrnico o mensajes de correo electrnico de marketing y
campaas transaccionales. Enviamos mil millones de correos electrnicos cada
mes, por lo que podemos manejar su correo electrnico sin importar el
volumen.
Desarrolladores

Para los desarrolladores, es muy fcil para empezar. Para enviar correo
electrnico a travs SendGrid de su cdigo, basta con cambiar la configuracin
de su correo electrnico para que apunte a nuestros servidores e incluir las
credenciales de su cuenta SendGrid, y ya est. Si usted an no est enviando
correo electrnico de su aplicacin, tenemos una variedad de opciones de
integracin para usted.

Una vez que tenga el envo de correo electrnico cuadrado de distancia, echa
un vistazo a algunas de las otras cosas impresionantes que se pueden hacer
con nuestras APIs y aplicaciones .

Campaas de marketing

Nuestra funcin de las campaas de marketing le permite crear y enviar

campaas de correo electrnico. Proporcionamos gestin de la lista, el
programa de entrega, pruebas de divisin A / B, el anlisis de correo
electrnico, y la lista dinmica de segmentacin. Puede echar un vistazo a
nuestra documentacin campaas de marketing para aprender ms.

Tambin proporcionamos una robusta API de campaas de marketing , si

desea integrar cualquiera de estas caractersticas en su propia aplicacin.

ndice de Referencia API

La versin 3 del API
Nuestro API REST V3 proporciona la funcionalidad para la gestin cancela la
suscripcin del usuario , templating mensajes de correo electrnico , la gestin
de direcciones IP , y la aplicacin de TLS .

Enviar correo electrnico

Enviar correo v3
Puede enviar correo electrnico mediante el envo de correo punto final en nuestra
versin 3 del API Web. Para obtener ms informacin sobre cmo iniciar el envo de
correo electrnico que utiliza este criterio de valoracin, por favor visite el correo v3
Enviar general .

Enviar correo v2

Tambin puede seguir utilizando nuestra Web API v2 electrnico Enviar punto
final para enviar correo electrnico.

Campaas de marketing API

La API del correo electrnico SendGrid marketing proporciona a los

desarrolladores la capacidad de gestionar correos electrnicos de
marketing , listas , las identidades y los eventos de entrega de programacin

SMTP

Este es un protocolo en lugar de un API. SMTP es ampliamente apoyada por

las aplicaciones y suele ser la manera ms rpida para integrarse con
SendGrid. Aprender a integrar a travs de SMTP .

SMTPAPI

Cuando se enva con SMTP, el API SMTP le permite aadir instrucciones

especficas a sus mensajes de correo electrnico SMTP, que coinciden con la
funcionalidad de nuestro criterio de valoracin electrnico. Se pueden aadir
argumentos personalizados, el seguimiento de su compromiso de mensajes de
correo electrnico, y enviar varios correos electrnicos con la misma
peticin. Uso de la API SMTP

Recibir correo
SendGrid puede analizar los cuerpos de correo electrnico y archivos adjuntos
de los correos electrnicos entrantes y los cuelgue en su aplicacin web. Para
ms detalles sobre cmo integrar su aplicacin para empezar a recibir
mensajes de correo electrnico por favor refirase a nuestra Parse web
hook . Ejemplos de aplicaciones incluyen:

La publicacin de artculos blog por correo electrnico

correo electrnico para procesar las respuestas en una lista de correo
Lo que permite a los usuarios subir fotos a su perfil por correo electrnico
Enviar solicitudes de soporte va e-mail

En tiempo real web hook notificacin de eventos

SendGrid puede enviar notificaciones en tiempo real acerca de los eventos que
suceden en el sistema SendGrid a una URL. Estos eventos incluyen los clics,
se abre, darse de baja, rebotes, y muchos otros. Estos eventos incluyen ms
datos que lo SendGrid registros y permiten a los clientes personalizar sus
propios informes. Lo que hace que esta API an ms potente es la capacidad
de incluir parmetros definidos por el usuario en cada caso. A travs de nuestra
API SMTP, los clientes pueden integrar parmetros nicos en cada correo
electrnico que envan. Estos parmetros se pasan entonces a cada
notificacin de eventos por lo que su aplicacin puede asociar estos eventos
con sus clientes. Lea ms sobre la web hook Evento . Ejemplos de aplicaciones
incluyen:

Asociar un informe de spam con una campaa y usuario especfico en su

aplicacin
Conocer en tiempo real cuando un usuario ha hecho clic en un correo
electrnico de confirmacin
El enlace especfico hace clic en un correo electrnico
Obtener la versin del navegador utilizado por un cliente
Conocer la respuesta MTA especfico para un cliente

Configurar su cuenta SendGrid

La Web API permite a los clientes crear subcuentas y controlar la configuracin
de estas cuentas para una configuracin de OEM. Ver la lista de llamadas a la
API Web
Puede configurar los ajustes de la cuenta, tales como la actualizacin de
su informacin de perfil . Tambin puede configuracin SendGrid
Aplicaciones , configurar aplicaciones y configurar los ajustes Parse web hook .

Con compaeros de equipo , puede agregar varios usuarios a la misma cuenta

SendGrid. Los compaeros de equipo le da la capacidad para crear y gestionar
muchos usuarios de cuentas diferentes, cada uno con su propio conjunto de
permisos y niveles de acceso. Para obtener ms informacin sobre los
compaeros de equipo, visite nuestra Gua del usuario o nuestra API de
referencia .

Recuperar la informacin
SendGrid tiene una API Web que permite a los clientes para recuperar
informacin sobre su cuenta, como las estadsticas, rebotes, informes de spam,
cancela la suscripcin, y otra informacin.

Se puede recuperar informacin a travs de nuestros puntos finales de API

para los bloques , las despedidas , los correos electrnicos no vlidos , los
informes de spam , anulaciones de suscripcin y Estadstica .

distribuidor API
Distribuidor API - Permite SendGrid distribuidor CUTOMERS para gestionar
todos los aspectos de las cuentas de sus clientes SendGrid.
Haiku distribuidor API - Permite SendGrid revendedor a los clientes administrar
servidores y cuentas a travs de SendGrid.

Api zoho
Ayuda de desarrollo de Zoho CRM
Zoho CRM proporciona REST API (Application Programming Interface) que
permite integrar CRM con aplicaciones de terceros, tales como la contabilidad,
ERP, comercio electrnico, portales de autoservicio y otros.

Al trabajar con la API de Zoho CRM, asegurarse de que est utilizando la

ltima versin de la API. versiones de la API es el proceso de creacin de
nuevos puntos finales de API y la adicin de la funcionalidad, lo que asegura
que las API son accesibles a todas las aplicaciones de terceros e integraciones
para uso continuo.

Zoho CRM API

Integrar sus aplicaciones de negocio con la API de Zoho CRM. Acceder a la
documentacin de las versiones anteriores del API aqu .

API Methods
Method Name Purpose

To retrieve data by the owner of the Authentication Token

getMyRecords
specified in the API request

getRecords To retrieve all users data specified in the API request

getRecordById To retrieve individual records by record ID

getDeletedRecordIds To retrieve the list of IDs of deleted records from recylce bin

insertRecords To insert records into the required Zoho CRM module

updateRecords To update or modify the records in Zoho CRM

getSearchRecordsByPDC To search the values based on pre-defined columns

deleteRecords To delete the selected records

convertLead To convert lead to potential, account and contact

getRelatedRecords To retrieve records related to a primary module

getFields To retrieve details of fields available in a module

updateRelatedRecords To update records related to another record

getUsers To retrieve the list of users in your organization

uploadFile To attach a file to a record

delink To disassociate the relationship between parent and child records

downloadFile To download a file attached to a record

deleteFile To delete a file attached to a record

uploadPhoto To add a photo to a contact or lead

downloadPhoto To download the photo of a contact or lead

deletePhoto To delete a photo of a contact or lead

getModules To retrieve all modules from Zoho CRM account

searchRecords To retrieve the records that match your search criteria