Skip to Content
SDKsGoSender IDs

Sender IDs

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

reqs, err := client.SenderIDs.Requirements(ctx)           // SenderIDRequirements (eligibility, rules, docs)
usable, err := client.SenderIDs.Usable(ctx, "")            // []UsableSenderID available for sending
list, err := client.SenderIDs.List(ctx)                    // []SenderID registered on the account
 
newID, err := client.SenderIDs.Create(ctx, sendafrica.CreateSenderIDRequest{
    Name:          "MYBRAND",
    Country:       "TZ",
    Purpose:       "Marketing",
    SampleMessage: "Welcome to MYBRAND",
    // Documents: []SenderIDDocumentInput{{RequirementUID, Filename, ContentBase64}},
})
 
one, err := client.SenderIDs.Get(ctx, newID.ID)
MethodEndpoint
SenderIDs.Requirements(ctx, opts...)GET /sender-ids/requirements
SenderIDs.Usable(ctx, provider, opts...)GET /sender-ids/usable
SenderIDs.List(ctx, opts...)GET /sender-ids
SenderIDs.Create(ctx, CreateSenderIDRequest, opts...)POST /sender-ids
SenderIDs.Get(ctx, id, opts...)GET /sender-ids/{id}

Returned SenderID objects carry ID, Name, Status, Type, and IsDefault. Only usable sender IDs can appear in the Sender field of a send.

Last updated on
RatesWebhooks