Account¶

Query your account's credit balance and configured email senders.

Get credits¶

Returns remaining SMS and email credits for your store.

GET /api/v1/account/credits

Example¶

cURLPython

curl "https://admin.notifybulk.com/api/v1/account/credits" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests

r = requests.get(
    'https://admin.notifybulk.com/api/v1/account/credits',
    headers={'Authorization': 'Bearer YOUR_API_TOKEN'}
)
print(r.json())

Response¶

{
  "success": true,
  "credits": {
    "sms": {
      "remaining": 482,
      "total": 500,
      "rollover": 0
    },
    "email": {
      "remaining": 9840,
      "total": 10000,
      "rollover": 150
    }
  }
}

Field	Type	Description
`remaining`	integer	Credits available to use right now (includes active rollover)
`total`	integer	Credits included in your current plan period
`rollover`	integer	Rollover credits from a previous period (included in `remaining`)

List senders¶

Returns the verified email senders configured for your store.

GET /api/v1/senders

Use the id as sender_id in Send Email to control which sender address is used.

Example¶

cURL

curl "https://admin.notifybulk.com/api/v1/senders" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response¶

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Acme Support",
      "email": "[email protected]"
    },
    {
      "id": 2,
      "name": "Acme Newsletter",
      "email": "[email protected]"
    }
  ]
}

Tip

Senders are configured in Settings → Email Senders. Only verified senders appear here.