Skip to main content
WEBHOOK
emailMarketingUnsubscribed
{
  "subscription_type": "domain subscription cancelled",
  "type": "Email marketing",
  "campid": "123",
  "campaignName": "Test campaign name",
  "subject": "Test campaign subject",
  "event": "unsubscribed",
  "relid": "123",
  "email": "test@testdomain.com",
  "domain": "testdomain.com",
  "reason": "test reason",
  "timestamp": "2020-10-02 18:03:16"
}

Documentation Index

Fetch the complete documentation index at: https://docs.opptima.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Usa tu API Key como Bearer token en el header Authorization.

Ejemplo: Authorization: Bearer YOUR_API_KEY

Obtén tu API Key en la página de Settings.

Body

application/json
​
subscription_type
string

Tipo de evento de suscripción. Valores posibles: domain subscription cancelled, domain subscription reactivated, domain category update

Example:

"domain subscription cancelled"

​
type
string

Tipo de evento (siempre "Email marketing" para este grupo)

Example:

"Email marketing"

​
event
string

Evento generado (siempre "unsubscribed" para este webhook)

Example:

"unsubscribed"

​
campid
string

ID único de la campaña

Example:

"123"

​
relid
string

ID interno del cliente

Example:

"123"

​
timestamp
string

Fecha y hora del evento, zona horaria colombiana (GMT -5)

Example:

"2020-10-02 18:03:16"

​
email
string

Dirección del destinatario cuya suscripción fue actualizada

Example:

"test@testdomain.com"

​
campaignName
string

Nombre interno de la campaña

Example:

"Test campaign name"

​
subject
string

Asunto de la campaña

Example:

"Test campaign subject"

​
domain
string

Dominio asociado a la suscripción

Example:

"testdomain.com"

​
reason
string

Razón proporcionada por el destinatario. Para desuscripciones en un click: "Cancelación de suscripción en un click". Para desuscripciones via email: "Cancelación via Email"

Example:

"test reason"

​
categories
object

Cuando el destinatario actualiza solo las categorías de suscripción, contiene cada categoría del dominio con su estado (active/cancelled)

Example:
{
  "Category1": "cancelled",
  "Category2": "cancelled",
  "Category3": "active"
}

Response

200

Webhook recibido correctamente