Skip to main content
Create Template
curl --request POST \
  --url https://api.example.com/api/v2/Template \
  --header 'Content-Type: application/json' \
  --data '
{
  "TemplateName": "<string>",
  "MessageTemplate": "<string>",
  "ApiKey": "<string>",
  "ClientId": "<string>"
}
'
{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ruach.ng/llms.txt

Use this file to discover all available pages before exploring further.

​
Create Template

Create a new message template for reusable SMS content. 
curl -X POST "https://accounts.netvox.ng/api/v2/Template" \
  -H "Content-Type: application/json" \
  -d '{
    "TemplateName": "Welcome Message",
    "MessageTemplate": "Welcome to ##CompanyName##! Your account ID is ##AccountId##. Thank you for joining us.",
    "ApiKey": "YOUR_API_KEY",
    "ClientId": "YOUR_CLIENT_ID"
  }'

​
Request Body

​
TemplateName
string
required
Name of the template
​
MessageTemplate
string
required
Template content with placeholders using ##Field## format
​
ApiKey
string
required
Your API key for authentication
​
ClientId
string
required
Your client identifier for authentication

​
Response

​
ErrorCode
number
Error code (0 for success)
​
ErrorDescription
string
Description of the result
​
Data
string
Success message

​
Success Response

{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": "Template Added successfully."
}

​
Template Placeholders

Use ##FieldName## format for dynamic content:

​
Common Placeholders

  • ##Name## - Customer name
  • ##CompanyName## - Company name
  • ##AccountId## - Account identifier
  • ##Amount## - Transaction amount
  • ##Date## - Date
  • ##Time## - Time
  • ##OTP## - One-time password
  • ##Link## - URL link

​
Template Examples

​
Welcome Template

Welcome to ##CompanyName##! Your account ID is ##AccountId##. Thank you for joining us.

​
OTP Template

Your OTP is ##OTP##. Valid for 5 minutes. Do not share with anyone.

​
Payment Confirmation

Payment of ##Amount## received successfully on ##Date##. Transaction ID: ##TransactionId##

​
Appointment Reminder

Reminder: Your appointment with ##DoctorName## is scheduled for ##Date## at ##Time##.

​
Use Cases

  • Consistency: Maintain consistent messaging across all communications
  • Efficiency: Save time by reusing approved templates
  • Personalization: Combine templates with dynamic data
  • Compliance: Use pre-approved templates for regulated content