Create Sender ID
curl --request POST \
--url https://api.example.com/api/v2/SenderId \
--header 'Content-Type: application/json' \
--data '
{
"SenderId": "<string>",
"Purpose": "<string>",
"ApiKey": "<string>",
"ClientId": "<string>"
}
'import requests
url = "https://api.example.com/api/v2/SenderId"
payload = {
"SenderId": "<string>",
"Purpose": "<string>",
"ApiKey": "<string>",
"ClientId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
SenderId: '<string>',
Purpose: '<string>',
ApiKey: '<string>',
ClientId: '<string>'
})
};
fetch('https://api.example.com/api/v2/SenderId', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ErrorCode": 123,
"ErrorDescription": "<string>",
"Data": "<string>"
}Sender ID Management
Create Sender ID
Create a new sender ID for SMS messaging
Create Sender ID
curl --request POST \
--url https://api.example.com/api/v2/SenderId \
--header 'Content-Type: application/json' \
--data '
{
"SenderId": "<string>",
"Purpose": "<string>",
"ApiKey": "<string>",
"ClientId": "<string>"
}
'import requests
url = "https://api.example.com/api/v2/SenderId"
payload = {
"SenderId": "<string>",
"Purpose": "<string>",
"ApiKey": "<string>",
"ClientId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
SenderId: '<string>',
Purpose: '<string>',
ApiKey: '<string>',
ClientId: '<string>'
})
};
fetch('https://api.example.com/api/v2/SenderId', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ErrorCode": 123,
"ErrorDescription": "<string>",
"Data": "<string>"
}Create Sender ID
Create a new sender ID for your SMS messages. All sender IDs must be approved before they can be used.curl -X POST "https://app.notify.ng/api/v2/SenderId" \
-H "Content-Type: application/json" \
-d '{
"SenderId": "YOURBRAND",
"Purpose": "Marketing and notifications",
"ApiKey": "YOUR_API_KEY",
"ClientId": "YOUR_CLIENT_ID"
}'
const response = await fetch('https://app.notify.ng/api/v2/SenderId', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
SenderId: 'YOURBRAND',
Purpose: 'Marketing and notifications',
ApiKey: 'YOUR_API_KEY',
ClientId: 'YOUR_CLIENT_ID'
})
});
const data = await response.json();
console.log(data);
import requests
url = "https://app.notify.ng/api/v2/SenderId"
data = {
"SenderId": "YOURBRAND",
"Purpose": "Marketing and notifications",
"ApiKey": "YOUR_API_KEY",
"ClientId": "YOUR_CLIENT_ID"
}
response = requests.post(url, json=data)
result = response.json()
print(result)
Request Body
string
required
Valid sender ID (3-11 characters, alphanumeric only)
string
required
Purpose or description of the sender ID
string
required
Your API key for authentication
string
required
Your client identifier for authentication
Response
number
Error code (0 for success)
string
Description of the result
string
Success message
Success Response
{
"ErrorCode": 0,
"ErrorDescription": "Success",
"Data": "Senderid Added successfully."
}
Error Response
{
"ErrorCode": 027,
"ErrorDescription": "Already exist"
}
Sender ID Guidelines
Valid Sender IDs
- Alphanumeric only: Letters and numbers
- Length: 3-11 characters
- Examples:
YOURBRAND,SMS123,COMPANY
Invalid Sender IDs
- Special characters:
@,#,$, etc. - Spaces or punctuation
- Too short (< 3 characters) or too long (> 11 characters)
Approval Process
- Submit: Create sender ID via API
- Review: Our team reviews the request
- Approval: Sender ID is approved for use
- Activation: Start using the approved sender ID
Use Cases
- Brand recognition: Use your company name as sender ID
- Marketing campaigns: Create branded sender IDs for campaigns
- Service notifications: Use descriptive sender IDs for different services
- Compliance: Ensure all sender IDs are properly approved

