Recipient notifications

Automatic emails and WhatsApp messages to your buyer at every shipment milestone, with consent rules and per-event, per-channel control.

SendIt can notify your buyer, the person receiving the package, as their order moves. Notices go out by email and WhatsApp, in Spanish, with nothing for you to build. You control which events notify and over which channel.

What gets notified

Delivery happens in the background. It never delays the label purchase or the API response.

Consent rules

• WhatsApp requires explicit opt-in. LFPDPPP (Mexico’s data-protection law) requires consent before any message. WhatsApp is sent only when the shipment’s linked order has customerOptInToWhatsapp: true. A shipment with no linked order can never receive WhatsApp.
• Email is transactional. These are service messages about the recipient’s own shipment, so no per-recipient opt-in is needed. The org-level toggle below is the control. The email comes from the order’s customerEmail, and falls back to the destination address’s contact email.
• Test mode never notifies. Any operation with livemode: false is recorded as SKIPPED and sends nothing real.

WhatsApp messages use Meta pre-approved templates, in Spanish (es-MX). For example, the label_purchased template includes the tracking number, the carrier, and the estimated delivery date.

Control what gets sent

Toggles are per organization, per event, per channel. A missing toggle means enabled (the feature ships on): you only create rows to turn things off.

Fetch the full matrix

curl https://api.sendit.mx/v1/notification-settings \
  -H "X-API-Key: sk_live_..."

{
  "success": true,
  "data": [
    { "eventType": "order_confirmed", "channel": "EMAIL", "isEnabled": true, "subjectOverride": null },
    { "eventType": "order_confirmed", "channel": "WHATSAPP", "isEnabled": true },
    { "eventType": "label_purchased", "channel": "EMAIL", "isEnabled": true, "subjectOverride": "Tu guía {{trackingNumber}} está lista" },
    { "eventType": "shipment_delivered", "channel": "WHATSAPP", "isEnabled": false }
  ]
}

4 events × 2 channels = 8 rows with their effective values. Email rows also carry subjectOverride, which is null when you use SendIt’s own subject. WhatsApp rows omit it. Any authenticated member can read the settings; the notification_settings:read scope applies to API keys only.

Turn toggles off or on

curl -X PUT https://api.sendit.mx/v1/notification-settings \
  -H "X-API-Key: sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "settings": [
      { "eventType": "shipment_delivered", "channel": "WHATSAPP", "isEnabled": false }
    ]
  }'

Requires the OPERATOR role or above and the notification_settings:write scope. It’s a partial update: you only touch the rows you send.

Body parameters

Turning a channel off stops that notification org-wide. Turning WhatsApp off has no effect on messages already suppressed for lack of opt-in.

Customize the email subject

On an EMAIL row, subjectOverride replaces SendIt’s own subject. Omit it to leave the subject as is, send a string of up to 150 characters to replace it, or send null to restore the original.

curl -X PUT https://api.sendit.mx/v1/notification-settings \
  -H "X-API-Key: sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "settings": [
      {
        "eventType": "label_purchased",
        "channel": "EMAIL",
        "isEnabled": true,
        "subjectOverride": "Tu guía {{trackingNumber}} está lista"
      }
    ]
  }'

Each event accepts only its own variables:

Put your brand on the emails

Recipient emails can carry your logo, your color, and your footer. With publicTrackingPage on, that same branding appears on the public tracking page.

Body parameters

replyTo applies to email only and never appears in the public response. logoUrl and accentColor apply to both.

curl -X PUT https://api.sendit.mx/v1/notification-settings/branding \
  -H "X-API-Key: sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "logoUrl": "https://cdn.tutienda.mx/logo.png",
    "accentColor": "#4361EE",
    "replyTo": "hola@tutienda.mx",
    "footerText": "Gracias por comprar en Tu Tienda.",
    "publicTrackingPage": true
  }'

{
  "success": true,
  "data": {
    "logoUrl": "https://cdn.tutienda.mx/logo.png",
    "accentColor": "#4361EE",
    "replyTo": "hola@tutienda.mx",
    "footerText": "Gracias por comprar en Tu Tienda.",
    "publicTrackingPage": true
  }
}

Every field is optional, and GET omits the ones you never set. A brand-new organization returns { "success": true, "data": {} }.

WhatsApp templates never change.

Browse the templates

GET /v1/notification-templates returns the template catalog, one entry per event and channel (4 × 2 = 8), so your dashboard can render a preview gallery. It is read-only and uses the notification_settings:read scope. Templates are not editable: the copy is Meta-approved for WhatsApp, or code-owned for email.

curl https://api.sendit.mx/v1/notification-templates \
  -H "X-API-Key: sk_live_..."

{
  "success": true,
  "data": [
    {
      "eventType": "label_purchased",
      "channel": "EMAIL",
      "variables": ["customerName", "carrier", "trackingNumber", "estimatedDelivery"],
      "subject": "Tu envío está en camino — FEDMX123456789",
      "exampleBody": "Hola María,\n\nGeneramos la guía de tu envío con FedEx.\n…"
    },
    {
      "eventType": "label_purchased",
      "channel": "WHATSAPP",
      "variables": ["customerName", "carrier", "trackingNumber", "estimatedDelivery"],
      "templateName": "label_purchased",
      "exampleBody": "Hola María, …",
      "configured": true
    }
  ]
}

Email entries render with your active branding and subject: subject reflects your subjectOverride if you set one, and exampleHtml returns the preview with your logo, color, and footer.

WhatsApp templates are in Spanish (es-MX), Meta pre-approved, and shown unbranded. configured indicates whether the template is available. The email channel works independently.

Delivery semantics

• No duplicates. Reprocessing the same event does not send a second message through the same channel.
• Channels are independent. A failure on one channel never blocks the other or your webhooks.