Skip to content

API Reference

The NotifyBulk API lets you send SMS and email, manage contacts and groups, and query your account — all programmatically.

Base URL 

https://admin.notifybulk.com/api/v1

Authentication

Every request must include a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Your API token is available in Settings → Integrations → API Token. Keep it secret — it has full access to your store.

Token security

Never expose your API token in client-side code or public repositories. Regenerate it immediately if compromised.

Request format

All endpoints accept and return JSON. Set Content-Type: application/json on POST/PUT requests.

POST /api/v1/sms/send
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN

{
  "to": "+12125551234",
  "message": "Hello from NotifyBulk!"
}

Response format

All responses are JSON objects with a success boolean:

{
  "success": true,
  "sid": "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "queued",
  "segments_used": 1,
  "credits_remaining": 498
}

{
  "success": false,
  "error": "\"to\" must be a valid phone number in E.164 format"
}

HTTP status codes

Code Meaning
200 Success
201 Resource created
400 Bad request — invalid or missing parameters
401 Unauthorized — missing or invalid API token
402 Payment required — insufficient credits
403 Forbidden — feature not in your plan or account suspended
404 Resource not found
405 Method not allowed
409 Conflict — duplicate resource (e.g. contact with same email)
429 Rate limit exceeded
451 Content blocked by moderation filter
500 Server error

Rate limits

Rate limits depend on your plan. Limits are applied per endpoint type (sms, email, general):

Header Description
X-RateLimit-Limit-Minute Max requests per minute
X-RateLimit-Remaining-Minute Remaining requests this minute
X-RateLimit-Limit-Hour Max requests per hour
X-RateLimit-Remaining-Hour Remaining requests this hour

When a limit is exceeded, the API returns 429 with a Retry-After header indicating when to retry.

Plan requirements

  • Your store must have an active subscription to use the API.
  • API access must be included in your plan (api_access_enabled). Contact support if you need API access.
  • SMS and email endpoints require the respective credit type to be included in your plan.

Endpoints

Method Endpoint Description
POST /sms/send Send an SMS message
POST /email/send Send a transactional email
GET /contacts List contacts
POST /contacts/create Create a contact
PUT /contacts/update Update a contact
GET /groups List contact groups
POST /groups/create Create a group
GET /templates List email and SMS templates
GET /senders List email senders
GET /account/credits Get remaining credits