Skip to main content
POST
/
sendSMSRequest
Send SMS notification (server-to-server)
curl --request POST \
  --url http://localhost/mogl/mogl-backend/api/sendSMSRequest \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "template": "sms_notification",
  "replace_data": [],
  "receiver_contact_number": "+15551234567"
}
'
{
  "status": "success",
  "message": "SMS sent successfully."
}

Authorizations

​
X-API-KEY
string
header
required

Server-to-Server API Key for internal/lambda/cron calls

Body

application/json
​
template
string

SMS template name

Example:

"sms_notification"

​
replace_data
object

Key-value pairs to replace in the template

Example:
[]
​
receiver_contact_number
string

Recipient phone number

Example:

"+15551234567"

Response

200 - application/json

SMS sent

​
status
string
Example:

"success"

​
message
string
Example:

"SMS sent successfully."