Skip to main content
POST
/
api
/
v1
/
notifications
/
email
Send Email notification
curl --request POST \
  --url https://notification.platform.dev.ai71services.ai/api/v1/notifications/email \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "message_category": "OTP",
  "payload": {
    "html": "<string>",
    "sender": "<string>",
    "subject": "<string>",
    "to": "<string>",
    "template_fields": {
      "message": {
        "from_email": "<string>",
        "from_name": "<string>",
        "merge_language": "<string>",
        "subject": "<string>",
        "to": [
          {
            "email": "<string>",
            "name": "<string>",
            "type": "<string>"
          }
        ],
        "global_merge_vars": [
          {
            "content": {},
            "name": "<string>"
          }
        ]
      },
      "template_content": [
        {}
      ],
      "template_name": "<string>"
    }
  },
  "retry_enabled": true
}
'
{
  "message": "<string>",
  "request_id": "<string>"
}

Headers

x-api-key
string
required

API key for authorization

Body

application/json

Notification request body

message_category
enum<string>
required
Available options:
OTP,
PASSWORD_RESET,
SECURITY_ALERT,
TRANSACTION_ALERT,
PAYMENT_CONFIRMATION,
FRAUD_ALERT,
TWO_FACTOR_AUTH_PROMPT,
CRITICAL_SYSTEM_OUTAGE,
DATA_BREACH_ALERT,
LEGAL_NOTICE_URGENT,
ACCOUNT_SUSPENSION,
UNRECOGNIZED_DEVICE_LOGIN,
MFA_FAILURE,
API_SECURITY_ALERT,
ACCOUNT_COMPROMISE_WARNING,
DEPENDENCY_FAILURE,
SUBSCRIPTION_OVERDRAFT_ALERT,
LICENSE_VIOLATION_ALERT,
LEGAL_COMPLIANCE_ALERT,
APPLICATION_PERFORMANCE_WARNING,
SLA_BREACH_NOTIFICATION,
SERVER_MAINTENANCE_ALERT,
HIGH_PRIORITY_SYSTEM_ALERT_FOR_ADMINS,
SUBSCRIPTION_RENEWAL_REMINDER,
BILLING_PAYMENT_DUE_REMINDER,
EVENT_REMINDER,
ACCOUNT_INACTIVITY_ALERT,
ACCOUNT_UPDATE_CONFIRMATION,
SESSION_TIMEOUT_WARNING,
QUOTA_STORAGE_LIMIT_WARNING,
SERVICE_PLAN_UPGRADE_SUGGESTION,
LICENSE_EXPIRATION_ALERT,
FRIEND_CONTACT_REQUEST,
INVITATION_ACCEPTANCE,
PENDING_APPROVAL_REQUEST,
PRIVACY_POLICY_UPDATE,
PRODUCT_SERVICE_UPDATE,
DOCUMENT_UPLOAD_VERIFICATION_REMINDER,
REVIEW_FEEDBACK_REQUEST,
THIRD_PARTY_INTEGRATION_FAILURE,
ACCOUNT_DOWNGRADE_WARNING,
JOB_COMPLETION_CONFIRMATION,
MODERATION_ALERT,
WORKFLOW_TRIGGER_ALERT,
TASK_ASSIGNMENT,
ACCOUNT_CONFIRMATION_EMAIL,
ACCOUNT_VERIFICATION_EMAIL,
NEWS_UPDATE,
MONTHLY_WEEKLY_SUMMARY,
COMMUNITY_ANNOUNCEMENTS,
PRODUCT_RECOMMENDATIONS,
CONTENT_RECOMMENDATIONS,
PERSONALIZED_OFFERS,
SURVEY_FEEDBACK_REQUEST,
SOCIAL_ENGAGEMENT_NOTIFICATIONS,
USER_ONBOARDING_WELCOME,
TUTORIALS_TIPS,
ANNIVERSARY_BIRTHDAY_GREETINGS,
HOLIDAY_GREETINGS,
ACCOUNT_MILESTONE_REMINDER,
SEASONAL_CONTENT_SUGGESTIONS,
EVENT_REGISTRATION_CONFIRMATION,
NEW_CONTENT_LAUNCH_ALERT,
REWARDS_PROGRAM_UPDATE,
RE_ENGAGEMENT_CAMPAIGNS,
CART_ABANDONMENT_REMINDER,
PRODUCT_BACK_IN_STOCK_ALERT,
DISCOUNTS_FOR_INACTIVE_USERS,
COMMUNITY_BASED_NEWS,
FITNESS_GOAL_REMINDERS,
JOB_SUGGESTIONS
payload
object
required
retry_enabled
boolean
required

Response

Email notification successfully enqueued

message
string
request_id
string