Authentication
There are several ways to send authenticated HTTP requests:
- Send a HTTP header
X-Mijorsoft-Api-Key: {api_key}, where{api_key}is your project API key - Send a HTTP header
Authorization: Bearer {dashboard_jwt}, where{dashboard_jwt}is a short-lived JWT used for key management (Token Access Authentication ↗)
You can manage your API keys on the API Tokens ↗ page. API keys do not have an expiration date; you may revoke them manually at any time.
All requests must be sent over HTTPS protocol.
Test an API key
The key is sent to our server route only to call GET /api/v1/context. It is not stored or logged.
HTTP Methods
Allowed HTTP requests include:
API context
GET/api/v1/contextGet API key context
Validates a key and returns its project and environment scope.
/api/v1/contextGet API key context
Validates a key and returns its project and environment scope.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- No path or query parameters.
Payload
No payload required
Successful response
{
"success": true,
"message": "Operation completed successfully.",
"data": {
"organization_id": "organization-uuid",
"project_id": "project-uuid",
"environment_id": "environment-uuid",
"environment_type": "DEVELOPMENT"
}
}Error responses
curl -X GET 'https://api.mijorsoft.com/api/v1/context' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY'Base URL: https://api.mijorsoft.com/api/v1
Notifications
POST/api/v1/notificationsSend direct email content
Sends an email to a destination supplied in this request.
/api/v1/notificationsSend direct email content
Sends an email to a destination supplied in this request.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- No path parameters.
Rules
- EMAIL requires recipient.email and content.EMAIL.subject.
- Provide content.EMAIL.body or content.EMAIL.html.
Payload
{
"recipient": {
"email": "junior@example.com",
"name": "Junior"
},
"channels": [
"EMAIL"
],
"locale": "fr",
"content": {
"EMAIL": {
"subject": "Paiement reçu",
"body": "Votre paiement de 15 000 XAF a été reçu.",
"action_url": "https://customer.example.com/orders/ORD-10042"
}
}
}Successful response
{
"success": true,
"message": "Notification queued.",
"data": {
"id": "01K5YB7T3NQKX...",
"status": "QUEUED",
"source": "API",
"locale": "fr",
"blocked_channels": [],
"recipient_reference": null,
"deliveries": [
{
"id": "01K5YB8...",
"channel": "EMAIL",
"provider": "SMTP",
"status": "QUEUED",
"attempts": 0,
"sent_at": null,
"delivered_at": null,
"failed_at": null,
"error_code": null
}
],
"created_at": "2026-09-23T12:00:00+00:00"
}
}Error responses
curl -X POST 'https://api.mijorsoft.com/api/v1/notifications' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY' \
--data '{
"recipient": {
"email": "junior@example.com",
"name": "Junior"
},
"channels": [
"EMAIL"
],
"locale": "fr",
"content": {
"EMAIL": {
"subject": "Paiement reçu",
"body": "Votre paiement de 15 000 XAF a été reçu.",
"action_url": "https://customer.example.com/orders/ORD-10042"
}
}
}'Base URL: https://api.mijorsoft.com/api/v1
POST/api/v1/notificationsSend using a template
Uses one active template for the requested channels and locale.
/api/v1/notificationsSend using a template
Uses one active template for the requested channels and locale.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- No path parameters.
Rules
- template and content are mutually exclusive.
- The template must support every requested channel and locale.
Payload
{
"recipient": {
"email": "junior@example.com",
"name": "Junior"
},
"channels": [
"EMAIL"
],
"locale": "fr",
"template": "payment_success",
"data": {
"name": "Junior",
"amount": "15,000 XAF",
"order_number": "ORD-10042"
}
}Successful response
{
"success": true,
"message": "Notification queued.",
"data": {
"id": "01K5YB7T3NQKX...",
"status": "QUEUED",
"source": "API",
"locale": "fr",
"blocked_channels": [],
"recipient_reference": null,
"deliveries": [
{
"id": "01K5YB8...",
"channel": "EMAIL",
"provider": "SMTP",
"status": "QUEUED",
"attempts": 0,
"sent_at": null,
"delivered_at": null,
"failed_at": null,
"error_code": null
}
],
"created_at": "2026-09-23T12:00:00+00:00"
}
}Error responses
curl -X POST 'https://api.mijorsoft.com/api/v1/notifications' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY' \
--data '{
"recipient": {
"email": "junior@example.com",
"name": "Junior"
},
"channels": [
"EMAIL"
],
"locale": "fr",
"template": "payment_success",
"data": {
"name": "Junior",
"amount": "15,000 XAF",
"order_number": "ORD-10042"
}
}'Base URL: https://api.mijorsoft.com/api/v1
POST/api/v1/notificationsSend Expo, FCM or APNS push
Sends Push content to up to 100 destinations supplied in the request.
/api/v1/notificationsSend Expo, FCM or APNS push
Sends Push content to up to 100 destinations supplied in the request.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- No path parameters.
Rules
- Providers: EXPO, FCM, APNS. Platforms: ANDROID, IOS, WEB.
- Expo supports ANDROID and IOS. APNS requires IOS and a 64-character hexadecimal token.
- Each destination creates its own delivery record.
Payload
{
"recipient": {
"push": [
{
"provider": "EXPO",
"platform": "ANDROID",
"token": "ExpoPushToken[xxxxxxxxxxxxxxxxxxxxxx]"
},
{
"provider": "FCM",
"platform": "ANDROID",
"token": "customer-fcm-registration-token"
}
]
},
"channels": [
"PUSH"
],
"locale": "en",
"content": {
"PUSH": {
"title": "Payment received",
"body": "Your payment has been confirmed.",
"image_url": "https://example.com/payment.png",
"action_url": "myapp://orders/ORD-10042",
"metadata": {
"order_number": "ORD-10042"
}
}
}
}Successful response
{
"success": true,
"message": "Notification queued.",
"data": {
"id": "01K5YB7T3NQKX...",
"status": "QUEUED",
"source": "API",
"locale": "en",
"blocked_channels": [],
"recipient_reference": null,
"deliveries": [
{
"id": "01K5YB8...",
"channel": "PUSH",
"provider": "EXPO",
"status": "QUEUED",
"attempts": 0,
"sent_at": null,
"delivered_at": null,
"failed_at": null,
"error_code": null
},
{
"id": "01K5YB8...",
"channel": "PUSH",
"provider": "FCM",
"status": "QUEUED",
"attempts": 0,
"sent_at": null,
"delivered_at": null,
"failed_at": null,
"error_code": null
}
],
"created_at": "2026-09-23T12:00:00+00:00"
}
}Error responses
curl -X POST 'https://api.mijorsoft.com/api/v1/notifications' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY' \
--data '{
"recipient": {
"push": [
{
"provider": "EXPO",
"platform": "ANDROID",
"token": "ExpoPushToken[xxxxxxxxxxxxxxxxxxxxxx]"
},
{
"provider": "FCM",
"platform": "ANDROID",
"token": "customer-fcm-registration-token"
}
]
},
"channels": [
"PUSH"
],
"locale": "en",
"content": {
"PUSH": {
"title": "Payment received",
"body": "Your payment has been confirmed.",
"image_url": "https://example.com/payment.png",
"action_url": "myapp://orders/ORD-10042",
"metadata": {
"order_number": "ORD-10042"
}
}
}
}'Base URL: https://api.mijorsoft.com/api/v1
POST/api/v1/notificationsSend a combined notification
Sends Email, Push and In-App from one template request.
/api/v1/notificationsSend a combined notification
Sends Email, Push and In-App from one template request.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- No path parameters.
Rules
- EMAIL requires recipient.email; PUSH requires recipient.push; IN_APP requires recipient.reference.
- recipient.reference is an opaque customer identifier, never an email address or phone number.
- Email branding controls are available only to Business and Enterprise organizations.
Payload
{
"recipient": {
"email": "junior@example.com",
"name": "Junior",
"reference": "customer-42",
"push": [
{
"provider": "EXPO",
"platform": "ANDROID",
"token": "ExpoPushToken[xxxxxxxxxxxxxxxxxxxxxx]"
}
]
},
"channels": [
"EMAIL",
"PUSH",
"IN_APP"
],
"locale": "fr",
"template": "payment_success",
"data": {
"name": "Junior",
"amount": "15,000 XAF",
"order_number": "ORD-10042"
}
}Successful response
{
"success": true,
"message": "Notification queued.",
"data": {
"id": "01K5YB7T3NQKX...",
"status": "QUEUED",
"source": "API",
"locale": "fr",
"blocked_channels": [],
"recipient_reference": "customer-42",
"deliveries": [
{
"id": "01K5YB8...",
"channel": "EMAIL",
"provider": "SMTP",
"status": "QUEUED",
"attempts": 0,
"sent_at": null,
"delivered_at": null,
"failed_at": null,
"error_code": null
}
],
"created_at": "2026-09-23T12:00:00+00:00"
}
}Error responses
curl -X POST 'https://api.mijorsoft.com/api/v1/notifications' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY' \
--data '{
"recipient": {
"email": "junior@example.com",
"name": "Junior",
"reference": "customer-42",
"push": [
{
"provider": "EXPO",
"platform": "ANDROID",
"token": "ExpoPushToken[xxxxxxxxxxxxxxxxxxxxxx]"
}
]
},
"channels": [
"EMAIL",
"PUSH",
"IN_APP"
],
"locale": "fr",
"template": "payment_success",
"data": {
"name": "Junior",
"amount": "15,000 XAF",
"order_number": "ORD-10042"
}
}'Base URL: https://api.mijorsoft.com/api/v1
GET/api/v1/notifications/{uuid}Get notification status
Polls the notification and its delivery records. There is no frontend WebSocket endpoint.
/api/v1/notifications/{uuid}Get notification status
Polls the notification and its delivery records. There is no frontend WebSocket endpoint.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- Path: uuid — notification UUID.
Rules
- Use polling and safely handle future unknown notification or delivery statuses.
- The response uses recipient_reference and does not contain the old external_id or reference fields.
Payload
No payload required
Successful response
{
"success": true,
"message": "Operation completed successfully.",
"data": {
"id": "01K5YB7T3NQKX...",
"status": "COMPLETED",
"source": "API",
"locale": "fr",
"blocked_channels": [],
"recipient_reference": "customer-42",
"deliveries": [
{
"id": "01K5YB8...",
"channel": "EMAIL",
"provider": "SMTP",
"status": "SENT",
"attempts": 1,
"sent_at": "2026-09-23T12:01:00+00:00",
"delivered_at": null,
"failed_at": null,
"error_code": null
}
],
"created_at": "2026-09-23T12:00:00+00:00"
}
}Error responses
curl -X GET 'https://api.mijorsoft.com/api/v1/notifications/NOTIFICATION_UUID' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY'Base URL: https://api.mijorsoft.com/api/v1
Events
POST/api/v1/eventsTrigger an event automation
Ingests an event and creates notifications from matching active rules.
/api/v1/eventsTrigger an event automation
Ingests an event and creates notifications from matching active rules.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
- Idempotency-Key: payment-ORD-10042
Parameters
- Optional Idempotency-Key header, maximum 191 characters.
Rules
- Include every destination required by channels that matching event rules could trigger.
- Reusing an idempotency key with different content returns HTTP 409.
Payload
{
"event": "payment.succeeded",
"recipient": {
"email": "junior@example.com",
"name": "Junior",
"reference": "customer-42",
"push": [
{
"provider": "FCM",
"platform": "ANDROID",
"token": "customer-fcm-registration-token"
}
]
},
"locale": "fr",
"data": {
"amount": "15,000 XAF",
"order_number": "ORD-10042"
}
}Successful response
{
"success": true,
"message": "Event accepted.",
"data": {
"id": "01K5YC...",
"status": "QUEUED",
"notifications": [
"01K5YD..."
]
}
}Error responses
curl -X POST 'https://api.mijorsoft.com/api/v1/events' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY' \
-H 'Idempotency-Key: payment-ORD-10042' \
--data '{
"event": "payment.succeeded",
"recipient": {
"email": "junior@example.com",
"name": "Junior",
"reference": "customer-42",
"push": [
{
"provider": "FCM",
"platform": "ANDROID",
"token": "customer-fcm-registration-token"
}
]
},
"locale": "fr",
"data": {
"amount": "15,000 XAF",
"order_number": "ORD-10042"
}
}'Base URL: https://api.mijorsoft.com/api/v1
In-app notifications
GET/api/v1/in-app/notifications?recipient_reference=RECIPIENT_REFERENCEList in-app notifications
Lists unexpired In-App notifications for one customer reference.
/api/v1/in-app/notifications?recipient_reference=RECIPIENT_REFERENCEList in-app notifications
Lists unexpired In-App notifications for one customer reference.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- Query: recipient_reference (required).
Payload
No payload required
Successful response
{
"success": true,
"data": [
{
"id": "in-app-notification-uuid",
"title": "Payment confirmed",
"message": "Your payment has been received.",
"type": null,
"icon": null,
"image_url": "https://cdn.example.com/payment.png",
"action_url": "https://app.example.com/payments/10042",
"metadata": {
"payment_id": "10042"
},
"seen_at": null,
"read_at": null,
"created_at": "2026-09-23T12:00:00+00:00"
}
],
"meta": {
"current_page": 1,
"per_page": 20,
"total": 1,
"last_page": 1
}
}Error responses
curl -X GET 'https://api.mijorsoft.com/api/v1/in-app/notifications?recipient_reference=RECIPIENT_REFERENCE' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY'Base URL: https://api.mijorsoft.com/api/v1
GET/api/v1/in-app/notifications/unread-count?recipient_reference=RECIPIENT_REFERENCEGet unread count
Returns the unread count for one customer reference.
/api/v1/in-app/notifications/unread-count?recipient_reference=RECIPIENT_REFERENCEGet unread count
Returns the unread count for one customer reference.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- Query: recipient_reference (required).
Payload
No payload required
Successful response
{
"success": true,
"message": "Operation completed successfully.",
"data": {
"count": 4
}
}Error responses
curl -X GET 'https://api.mijorsoft.com/api/v1/in-app/notifications/unread-count?recipient_reference=RECIPIENT_REFERENCE' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY'Base URL: https://api.mijorsoft.com/api/v1
PATCH/api/v1/in-app/notifications/{uuid}/seenMark as seen
Marks one In-App notification as seen and is safe to repeat.
/api/v1/in-app/notifications/{uuid}/seenMark as seen
Marks one In-App notification as seen and is safe to repeat.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- Path: uuid. Payload: recipient_reference.
Payload
{
"recipient_reference": "customer-42"
}Successful response
{
"success": true,
"message": "Operation completed successfully.",
"data": {
"id": "in-app-notification-uuid",
"title": "Payment confirmed",
"message": "Your payment has been received.",
"type": null,
"icon": null,
"image_url": "https://cdn.example.com/payment.png",
"action_url": "https://app.example.com/payments/10042",
"metadata": {
"payment_id": "10042"
},
"seen_at": "2026-09-23T12:05:00+00:00",
"read_at": null,
"created_at": "2026-09-23T12:00:00+00:00"
}
}Error responses
curl -X PATCH 'https://api.mijorsoft.com/api/v1/in-app/notifications/NOTIFICATION_UUID/seen' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY' \
--data '{
"recipient_reference": "customer-42"
}'Base URL: https://api.mijorsoft.com/api/v1
PATCH/api/v1/in-app/notifications/{uuid}/readMark as read
Marks one notification as read and seen and is safe to repeat.
/api/v1/in-app/notifications/{uuid}/readMark as read
Marks one notification as read and seen and is safe to repeat.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- Path: uuid. Payload: recipient_reference.
Payload
{
"recipient_reference": "customer-42"
}Successful response
{
"success": true,
"message": "Operation completed successfully.",
"data": {
"id": "in-app-notification-uuid",
"title": "Payment confirmed",
"message": "Your payment has been received.",
"type": null,
"icon": null,
"image_url": "https://cdn.example.com/payment.png",
"action_url": "https://app.example.com/payments/10042",
"metadata": {
"payment_id": "10042"
},
"seen_at": "2026-09-23T12:05:00+00:00",
"read_at": "2026-09-23T12:05:00+00:00",
"created_at": "2026-09-23T12:00:00+00:00"
}
}Error responses
curl -X PATCH 'https://api.mijorsoft.com/api/v1/in-app/notifications/NOTIFICATION_UUID/read' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY' \
--data '{
"recipient_reference": "customer-42"
}'Base URL: https://api.mijorsoft.com/api/v1
POST/api/v1/in-app/notifications/read-allMark all as read
Marks unread, unexpired notifications as read for one customer reference.
/api/v1/in-app/notifications/read-allMark all as read
Marks unread, unexpired notifications as read for one customer reference.
Authentication
Project API key
Headers
- Accept: application/json
- Content-Type: application/json
- X-Mijorsoft-Api-Key: YOUR_API_KEY
Parameters
- Payload: recipient_reference.
Payload
{
"recipient_reference": "customer-42"
}Successful response
{
"success": true,
"message": "Operation completed successfully.",
"data": {
"updated": 4
}
}Error responses
curl -X POST 'https://api.mijorsoft.com/api/v1/in-app/notifications/read-all' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Mijorsoft-Api-Key: YOUR_API_KEY' \
--data '{
"recipient_reference": "customer-42"
}'Base URL: https://api.mijorsoft.com/api/v1
Rate Limits
Limits apply per API key, not per IP. Exceeded requests return HTTP 429 with a Retry-After header.
Default
300 req / min / key
Burst
60 req / 10 s
Batch size
100 recipients / request
Response Codes
Every response is JSON. Handle unknown future codes defensively.
HTTP 2xx
{
"success": true,
"message": "Operation completed successfully.",
"data": {}
}HTTP 422
{
"success": false,
"message": "Validation failed.",
"errors": {
"field": [
"Validation message."
]
}
}INVALID_API_KEYInvalid or inactive API key.IP_NOT_ALLOWEDThis IP address is not allowed for the project.HTTP_404Resource not found.HTTP_409Request failed.VALIDATION_ERRORValidation failed. Display the field path returned in errors.RATE_LIMIT_EXCEEDEDRate limit exceeded.INTERNAL_ERRORInternal request failure.