Skip to Content
SDKsTypeScriptSender IDs

Sender IDs

Register and manage the sender IDs your messages go out on.

const reqs = await client.senderIds.requirements()
console.log(reqs.eligibility?.canRequest, reqs.purposes)
 
const usable = await client.senderIds.usable('swala')
const all = await client.senderIds.list()
 
const created = await client.senderIds.create({
  name: 'MYBRAND',
  country: 'TZ',
  purpose: 'Marketing',
  sampleMessage: 'Welcome to MYBRAND',
  documents: [{ requirementUid: '...', filename: 'doc.pdf', contentBase64: '...' }],
})
 
const one = await client.senderIds.get(created.id)
await client.senderIds.setDefault(created.id)
MethodEndpoint
senderIds.requirements()GET /sender-ids/requirements
senderIds.usable(provider?)GET /sender-ids/usable
senderIds.list()GET /sender-ids
senderIds.create(params)POST /sender-ids
senderIds.get(senderId)GET /sender-ids/{id}
senderIds.setDefault(senderId)PUT /sender-ids/default

Returned SenderID objects carry id, name, status, type, and isDefault. Only usable sender IDs can appear in the from field of a send.

Last updated on
RatesWebhooks