Skip to main content

​
Signature

createSenderID(senderID: string, countries: string[]): Promise<any>

​
HTTP request

POST https://api.pindo.io/sender_ids

​
Request body

The method sends the following JSON payload: 
{
  "sender_id": "<senderID>",
  "countries": ["<country-code>"]
}

​
Parameters

​
senderID
string
required
The alphanumeric sender ID you want to register (e.g. 'ematerw'). Must comply with country-specific character length rules.
​
countries
string[]
required
An array of ISO 3166-1 alpha-2 country codes indicating the countries where this sender ID should be active (e.g. ['RW'] for Rwanda).

​
Example

import { PindoSMS } from 'pindo-sms';

const pindo = new PindoSMS('your-api-token');

const result = await pindo.createSenderID('ematerw', ['RW']);

console.log(result);

​
Error handling

try {
  const result = await pindo.createSenderID('ematerw', ['RW']);
} catch (err) {
  console.error('Failed to create sender ID:', err.message);
}
Sender ID registration may require approval before the ID becomes active. Check your Pindo dashboard for the current status after creation.

Build docs developers (and LLMs) love

Get started for freeTalk to us