Crear contacto en GetResponse, con una API
Agrega un contacto a una campaña (lista de contactos). GetResponse responde 202 sin cuerpo y lo procesa en una cola que puede tardar unos minutos, así que encuentra el contactId después con Search contacts. En una lista de double opt-in, la persona recibe primero un email de confirmación. Un email que ya está en la lista responde 409.
- Identificador
- getresponse_create_contact
La llamada
POST https://connect.reportei.com/api/tools/getresponse_create_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"email": "<email>",
"campaign": {}
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| string | Sí | Email address of the contact. | |
| campaign | object | Sí | The campaign (contact list) of the contact, with campaignId from List campaigns. An email that is in another list becomes a separate contact in this one. |
| name | string | No | Name of the contact. |
| dayOfCycle | string | No | Day of the autoresponder cycle the contact starts on, as text, such as 0. Without it, the contact stays out of the cycle. |
| scoring | number | No | Score of the contact. |
| ipAddress | string | No | IPv4 or IPv6 address the person subscribed from. |
| openTrackingConsent | boolean | No | true when the person agreed to have email opens tracked, false otherwise. |
Conexiones posibles
Tu cliente conecta su cuenta de GetResponse una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Clave de API
Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/getresponse_create_contact. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de GetResponse
- Buscar contactosPOSTBusca los contactos de una o más campañas (listas de contactos) por estado de suscripción y, opcionalmente, por email o nombre. Los contactos de double opt-in sin confirmar aparecen solo aquí. Pagina con page y perPage, hasta 1000; una página menor que perPage es la última.
- Obtener contactoGETDevuelve un contacto activo con email, nombre, campaña, dayOfCycle, etiquetas y customFieldValues. Un contacto eliminado responde 404.
- Actualizar contactoPOSTActualiza un contacto. Solo cambian los campos enviados. Una campaña distinta mueve el contacto, con su historial y estadísticas, a esa lista.
- Listar campañasGETLista las campañas, que son las listas de contactos de GetResponse, con campaignId, nombre, languageCode e isDefault. Pagina con page y perPage, hasta 1000; una página menor que perPage es la última.
- Crear campañaPOSTCrea una campaña, que es una lista de contactos en GetResponse, y la devuelve con su campaignId. Una cuenta tiene hasta 1000 listas, y un nombre ya en uso responde 409.
- Listar newslettersGETLista las newsletters, borradores incluidos, con newsletterId, asunto, type, campaña, sendOn y sendMetrics, que trae delivered, openRate y clickRate. Pagina con page y perPage, hasta 1000; una página menor que perPage es la última.
- Obtener newsletterGETDevuelve una newsletter con su contenido, fromField, campaña, sendSettings, sendOn y sendMetrics.
- Crear newsletterPOSTCrea una newsletter. Con type broadcast, el valor por defecto, entra en la cola de envío de inmediato, o en sendSettings.sendOn; con type draft solo se guarda, para enviarla después con Send newsletter draft. GetResponse acepta 256 de estas llamadas por día.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
