Skip to main content

Send SMS (Individual) (v1)

Method & Path​

POST /api/v1/workspace/:workspaceId/sms/send

Description​

Sends a single SMS message to one mobile number.

Authentication​

Required: Workspace auth.

Persona Access:

  • Workspace Owner: Allowed
  • Staff (role-based): Requires sms.send
  • Customer(client): Not allowed

Headers​

  • Authorization: Bearer <workspaceToken>
  • Content-Type: application/json
  • X-Staff-Id: <staffId> (optional; required when acting as Staff)

Path Parameters​

NameTypeRequiredDescription
workspaceIdstringYesWorkspace ID

Request Body​

{
  "mobile": "+970599000000",
  "text": "مرحبا 👋"
}

Response 200 OK​

{
  "success": true,
  "message": "SMS sent successfully"
}

Common Errors​

  • 400 Bad Request: Invalid input
  • 401 Unauthorized: Missing/invalid workspace token
  • 403 Forbidden: Staff missing sms.send
  • 422 Unprocessable Entity: Insufficient SMS balance / validation failed
  • 500 Internal Server Error: Unexpected error