Intro

Welcome to NipaMail — your delivery rail for email and SMS that keeps teams shipping fast without wrestling infrastructure.

This guide walks you from zero to sent: authorize with your application credentials, fire off transactional messages with templates or inline HTML, attach assets or raw payloads, and keep an eye on tenant credits before you run low.

Every section is hands-on with copy‑paste curl calls, clear field tables, and the exact responses you should expect so you can integrate with confidence.

Start at authorization, explore transactional sending, then check credits to round out the flow; all endpoints share the base URL below.

Endpoints

https://api.nipamail.com

Quick start

1. Get an access token

curl -X POST https://api.nipamail.com/v1/auth/tokens \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=<APP_ID>&client_secret=<APP_SECRET>"

Use the returned access_token as Bearer <TOKEN> in the next steps.

2. Send a transactional email (inline HTML)

curl -X POST https://api.nipamail.com/v1/transactions \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "EMAIL",
    "message": {
      "sender": "Sender <no-reply@yourdomain.com>",
      "recipient": "user@example.com",
      "subject": "Welcome to NipaMail",
      "html": "PCFkb2N0eXBlIGh0bWw+PGh0bWw+PGJvZHk+PGgxPldlbGNvbWUgdG8gTmlwYU1haWw8L2gxPjxwPlRoaXMgaXMgYW4gaW5saW5lIEhUTUwuPC9wPjwvYm9keT48L2h0bWw+"
    }
  }'

Swap template_id and template_values in place of html if you want to render a stored template.

3. Check tenant credits

curl -X GET https://api.nipamail.com/v1/tenants/me/credits \
  -H "Authorization: Bearer <TOKEN>"