Go SDK

Setup & Initialization

1. Install Package:

go get github.com/pingram-io/pingram-go

2. Import:

import (
    pingram "github.com/pingram-io/pingram-go"
)

3. Initialize:

client := pingram.NewClient("pingram_sk_your_api_key")

* required

Region example:

client := pingram.NewClient("pingram_sk_...", pingram.WithRegion(pingram.RegionEU))

Working example

Full runnable example that sends a notification:

package main

import (
  "context"
  "encoding/json"
  "fmt"
  "log"

  pingram "github.com/pingram-io/pingram-go"
)

func main() {
  client := pingram.NewClient("pingram_sk_your_api_key") // or WithBaseURL("https://api.pingram.click") for custom host

  body := pingram.SenderPostBody{
    Type: pingram.PtrString("domain_verification"),
    User: &pingram.GetUsersResponseUsersInner{
      Id:    "user@example.com",
      Email: pingram.PtrString("user@example.com"),
    },
    Email: &pingram.SenderPostBodyEmail{
      Subject: "Domain Verification",
      Html:    "<p>Please verify your domain by clicking the link below.</p>",
    },
  }

  resp, _, err := client.DefaultAPI.Send(context.Background()).SenderPostBody(body).Execute()
  if err != nil {
    log.Fatal(err)
  }
  out, _ := json.MarshalIndent(resp, "", "  ")
  fmt.Println(string(out))
}

The sections below list every API method. For most use cases the Send method and the Domains / Users / Types APIs are the main ones.

Send

Send()

Send a notification (email, SMS, etc.) to one user. Requires a notification type which categorizes this messages for future reporting, and channel-specific payloads such as email or sms. Recipient is specified with the to parameter. Returns a trackingId for error or delivery lookup through our Logs.

senderPostBody := *pingram.NewSenderPostBody() // SenderPostBody

resp, _, err := client.DefaultAPI.Send(ctx).SenderPostBody(senderPostBody).Execute()
if err != nil {
  // handle error
}
// resp is SenderPostResponse

Parameters

Request Body Properties

Webhooks

WebhooksCreateWebhook()

Create a webhook endpoint on a server outside Pingram. Pingram later POSTs signed JSON to that URL when one of the subscribed events happens. This call only saves the endpoint; it does not send a webhook and does not modify the destination server. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.

webhookEndpointUpsertRequest := *pingram.NewWebhookEndpointUpsertRequest("Webhook_example", []string{"Events_example"}) // WebhookEndpointUpsertRequest

resp, _, err := client.WebhooksAPI.WebhooksCreateWebhook(ctx).WebhookEndpointUpsertRequest(webhookEndpointUpsertRequest).Execute()
if err != nil {
  // handle error
}
// resp is WebhookEndpoint

Parameters

Request Body Properties

WebhooksDeleteWebhook()

Delete one webhook endpoint by id from list or create. That URL stops receiving its events. Other endpoints on the account are left as they are.

endpointId :=  // Id of the webhook endpoint, from list or create.

_, err := client.WebhooksAPI.WebhooksDeleteWebhook(ctx, endpointId).Execute()
if err != nil {
  // handle error
}

Parameters

WebhooksListWebhooks()

List webhook endpoints on the current account, including each id, URL, subscribed events, and signing secret. Use the id with update or delete.

resp, _, err := client.WebhooksAPI.WebhooksListWebhooks(ctx).Execute()
if err != nil {
  // handle error
}
// resp is WebhookEndpointsResponse

Parameters

This endpoint does not need any parameter.

WebhooksUpdateWebhook()

Replace one webhook endpoint’s URL and its full event subscription. The URL is a server outside Pingram. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it, and the previous URL stops receiving events. The previous URL and event list are not kept. The URL must be a public HTTPS URL.

endpointId :=  // Id of the webhook endpoint, from list or create.
webhookEndpointUpsertRequest := *pingram.NewWebhookEndpointUpsertRequest("Webhook_example", []string{"Events_example"}) // WebhookEndpointUpsertRequest

resp, _, err := client.WebhooksAPI.WebhooksUpdateWebhook(ctx, endpointId).WebhookEndpointUpsertRequest(webhookEndpointUpsertRequest).Execute()
if err != nil {
  // handle error
}
// resp is WebhookEndpoint

Parameters

Request Body Properties

Accounts

AccountsCreateAccount()

Create one additional Pingram account (a separate workspace) for the signed-in user. The caller must already belong to an account. Requires a user session or personal access token; an account API key cannot call this. Does not create a login, and does not change, delete, or grant access to existing accounts. Omit plan and nothing is charged. The new account is ready for billing to be added later, and it cannot send until then. Setting plan charges immediately. It starts a paid subscription on the payment method already saved on sourceBillingAccountId, an account the caller must own. Optional memberEmails adds people who already share an account with the caller and invites everyone else.

createAccountRequest := *pingram.NewCreateAccountRequest("Name_example") // CreateAccountRequest

resp, _, err := client.AccountsAPI.AccountsCreateAccount(ctx).CreateAccountRequest(createAccountRequest).Execute()
if err != nil {
  // handle error
}
// resp is CreateAccountResponse

Parameters

Request Body Properties

AccountsListAccounts()

List accounts the authenticated user can access

resp, _, err := client.AccountsAPI.AccountsListAccounts(ctx).Execute()
if err != nil {
  // handle error
}
// resp is ListAccountsResponse

Parameters

This endpoint does not need any parameter.

Addresses

AddressesCreateAddress()

Create a new email inbox. Omit domain for a built-in @mail.pingram.io address; set domain and displayName for a custom address on a verified domain.

createAddressRequest := *pingram.NewCreateAddressRequest("Prefix_example") // CreateAddressRequest

resp, _, err := client.AddressesAPI.AddressesCreateAddress(ctx).CreateAddressRequest(createAddressRequest).Execute()
if err != nil {
  // handle error
}
// resp is AddressResponse

Parameters

Request Body Properties

AddressesDeleteAddress()

Delete a custom inbound address. Builtin addresses cannot be deleted.

fullAddress :=  // Full address to delete (e.g. hello@example.com)

resp, _, err := client.AddressesAPI.AddressesDeleteAddress(ctx, fullAddress).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

Parameters

AddressesListAddresses()

List email inboxes (addresses) configured for receiving. Custom addresses must use a verified domain.

resp, _, err := client.AddressesAPI.AddressesListAddresses(ctx).Execute()
if err != nil {
  // handle error
}
// resp is AccountAddressesResponse

Parameters

This endpoint does not need any parameter.

AddressesUpdateAddress()

Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.

updateAddressRequest := *pingram.NewUpdateAddressRequest("FullAddress_example") // UpdateAddressRequest

resp, _, err := client.AddressesAPI.AddressesUpdateAddress(ctx).UpdateAddressRequest(updateAddressRequest).Execute()
if err != nil {
  // handle error
}
// resp is AddressResponse

Parameters

Request Body Properties

Broadcasts

BroadcastsArchive()

Archive an email broadcast so it is hidden from the default broadcast list. Allowed for draft, paused, sent, and canceled broadcasts. Not allowed while sending or scheduled.

broadcastId :=  // Broadcast ID

resp, _, err := client.BroadcastsAPI.BroadcastsArchive(ctx, broadcastId).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastResponse

Parameters

BroadcastsCancel()

Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.

broadcastId :=  // Broadcast ID

resp, _, err := client.BroadcastsAPI.BroadcastsCancel(ctx, broadcastId).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastResponse

Parameters

BroadcastsCreate()

Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html. A later update can add it to a draft by sending it with html. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.

createBroadcastRequest := *pingram.NewCreateBroadcastRequest("Name_example", *pingram.NewBroadcastResponseAudience(), "FromName_example", "FromAddress_example", "Subject_example", "Html_example") // CreateBroadcastRequest

resp, _, err := client.BroadcastsAPI.BroadcastsCreate(ctx).CreateBroadcastRequest(createBroadcastRequest).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastResponse

Parameters

Request Body Properties

BroadcastsDelete()

Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.

broadcastId :=  // Broadcast ID

resp, _, err := client.BroadcastsAPI.BroadcastsDelete(ctx, broadcastId).Execute()
if err != nil {
  // handle error
}
// resp is MessageResponse

Parameters

BroadcastsGet()

Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.

broadcastId :=  // Broadcast ID

resp, _, err := client.BroadcastsAPI.BroadcastsGet(ctx, broadcastId).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastResponse

Parameters

BroadcastsGetMetrics()

Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).

broadcastId :=  // Broadcast ID

resp, _, err := client.BroadcastsAPI.BroadcastsGetMetrics(ctx, broadcastId).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastMetricsResponse

Parameters

BroadcastsList()

List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.

limit := float32(8.14) // float32 (optional)
nextToken := "nextToken_example" // string (optional)

resp, _, err := client.BroadcastsAPI.BroadcastsList(ctx).Limit(limit).NextToken(nextToken).Execute()
if err != nil {
  // handle error
}
// resp is ListBroadcastsResponse

Parameters

BroadcastsListRecipients()

List email broadcast recipients with per-recipient delivery fact timestamps (sentAt, deliveredAt, openedAt, etc.). Derive display status client-side from timestamps. Filter by status (pending, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed, problems). Paginate with limit (default 50, max 200) and nextToken.

broadcastId :=  // Broadcast ID
status := "status_example" // string (optional)
limit := float32(8.14) // float32 (optional)
nextToken := "nextToken_example" // string (optional)

resp, _, err := client.BroadcastsAPI.BroadcastsListRecipients(ctx, broadcastId).Status(status).Limit(limit).NextToken(nextToken).Execute()
if err != nil {
  // handle error
}
// resp is ListBroadcastRecipientsResponse

Parameters

status | string | Filter | limit | float32 | Max recipients to return (default 50) | nextToken | string | Pagination token |

BroadcastsPause()

Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.

broadcastId :=  // Broadcast ID

resp, _, err := client.BroadcastsAPI.BroadcastsPause(ctx, broadcastId).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastResponse

Parameters

BroadcastsResume()

Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.

broadcastId :=  // Broadcast ID

resp, _, err := client.BroadcastsAPI.BroadcastsResume(ctx, broadcastId).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastResponse

Parameters

BroadcastsSchedule()

Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.

broadcastId :=  // Broadcast ID
scheduleBroadcastRequest := *pingram.NewScheduleBroadcastRequest("SendAt_example") // ScheduleBroadcastRequest

resp, _, err := client.BroadcastsAPI.BroadcastsSchedule(ctx, broadcastId).ScheduleBroadcastRequest(scheduleBroadcastRequest).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastResponse

Parameters

Request Body Properties

BroadcastsSend()

Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.

broadcastId :=  // Broadcast ID

resp, _, err := client.BroadcastsAPI.BroadcastsSend(ctx, broadcastId).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastResponse

Parameters

BroadcastsUnarchive()

Restore an archived email broadcast to the default broadcast list.

broadcastId :=  // Broadcast ID

resp, _, err := client.BroadcastsAPI.BroadcastsUnarchive(ctx, broadcastId).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastResponse

Parameters

BroadcastsUpdate()

Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate is visual-editor source: send it with html to add it to an html-only draft or to update it. It cannot be removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.

broadcastId :=  // Broadcast ID
updateBroadcastRequest := *pingram.NewUpdateBroadcastRequest() // UpdateBroadcastRequest

resp, _, err := client.BroadcastsAPI.BroadcastsUpdate(ctx, broadcastId).UpdateBroadcastRequest(updateBroadcastRequest).Execute()
if err != nil {
  // handle error
}
// resp is BroadcastResponse

Parameters

Request Body Properties

Domains

DomainsAddDomain()

Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain’s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.

postSendersRequestBody := *pingram.NewPostSendersRequestBody("Sender_example") // PostSendersRequestBody

resp, _, err := client.DomainsAPI.DomainsAddDomain(ctx).PostSendersRequestBody(postSendersRequestBody).Execute()
if err != nil {
  // handle error
}
// resp is []GetSendersResponseInner

Parameters

Request Body Properties

DomainsDeleteDomain()

Remove a sender domain from the account.

sender :=  // Sender domain (URL encoded)

resp, _, err := client.DomainsAPI.DomainsDeleteDomain(ctx, sender).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

Parameters

DomainsListDomains()

List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.

resp, _, err := client.DomainsAPI.DomainsListDomains(ctx).Execute()
if err != nil {
  // handle error
}
// resp is []GetSendersResponseInner

Parameters

This endpoint does not need any parameter.

DomainsStartDomainVerification()

Start SES domain verification (DNS readiness is checked client-side via checkDomainDns)

sender :=  // Sender domain (URL encoded)

resp, _, err := client.DomainsAPI.DomainsStartDomainVerification(ctx, sender).Execute()
if err != nil {
  // handle error
}
// resp is []GetSendersResponseInner

Parameters

Email

EmailDeleteSuppressions()

Start removing all email suppressions of the given reason (retryable or bounces) for users in the environment. Returns immediately after the job is queued — suppressions are not yet cleared when this response is received. Large removals are processed in the background in batches.

reason :=  // Suppression reason to clear (retryable | bounces)

resp, _, err := client.EmailAPI.EmailDeleteSuppressions(ctx, reason).Execute()
if err != nil {
  // handle error
}
// resp is MessageResponse

Parameters

EmailSend()

Send an email. Requires type, to, subject, and html. Optional: fromAddress, fromName, schedule, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.

sendEmailRequest := *pingram.NewSendEmailRequest("Type_example", "To_example", "Subject_example", "Html_example") // SendEmailRequest

resp, _, err := client.EmailAPI.EmailSend(ctx).SendEmailRequest(sendEmailRequest).Execute()
if err != nil {
  // handle error
}
// resp is SendEmailApiResponse

Parameters

Request Body Properties

Environments

EnvironmentsListEnvironments()

Get all environments for the authenticated account

resp, _, err := client.EnvironmentsAPI.EnvironmentsListEnvironments(ctx).Execute()
if err != nil {
  // handle error
}
// resp is []GetEnvironmentsResponseInner

Parameters

This endpoint does not need any parameter.

EnvironmentsUpdateEnvironment()

Update environment settings (title, secret, disable sending, secure mode)

clientId :=  // Environment client ID
environmentPatchRequest := *pingram.NewEnvironmentPatchRequest() // EnvironmentPatchRequest

resp, _, err := client.EnvironmentsAPI.EnvironmentsUpdateEnvironment(ctx, clientId).EnvironmentPatchRequest(environmentPatchRequest).Execute()
if err != nil {
  // handle error
}
// resp is Environment

Parameters

Request Body Properties

Library

LibraryCreate()

Create an upload slot in the account library. contentType must be image/png, image/jpeg, image/gif, or image/webp. PUT the file to the returned uploadUrl with that Content-Type, then use the returned url in emails and the editor.

useCase :=  // Library use-case
createLibraryRequest := *pingram.NewCreateLibraryRequest("Filename_example", "ContentType_example") // CreateLibraryRequest

resp, _, err := client.LibraryAPI.LibraryCreate(ctx, useCase).CreateLibraryRequest(createLibraryRequest).Execute()
if err != nil {
  // handle error
}
// resp is CreateLibraryResponse

Parameters

Request Body Properties

LibraryList()

List files in the account library for a use-case, newest first. Paginate with limit (default 50, max 100) and nextToken.

useCase :=  // Library use-case
limit := float32(8.14) // float32 (optional)
nextToken := "nextToken_example" // string (optional)

resp, _, err := client.LibraryAPI.LibraryList(ctx, useCase).Limit(limit).NextToken(nextToken).Execute()
if err != nil {
  // handle error
}
// resp is ListLibraryResponse

Parameters

limit | float32 | Max items to return (default 50) | nextToken | string | Pagination token |

Logs

LogsGetDeliveryStatus()

Look up email and SMS delivery status for up to 25 tracking IDs. Each entry is the tracking id, channel (EMAIL or SMS), status, and the time that status was recorded. The result does not include recipients, phone numbers, user ids, request bodies, IP addresses, account ids, or user-agent data. Unknown tracking ids are omitted. Other channels are not included.

trackingIds :=  // Comma-separated tracking IDs (URL encoded, max 25)

resp, _, err := client.LogsAPI.LogsGetDeliveryStatus(ctx, trackingIds).Execute()
if err != nil {
  // handle error
}
// resp is LogsDeliveryStatusResponse

Parameters

LogsGetLogRetention()

Get log retention period in days for the account

resp, _, err := client.LogsAPI.LogsGetLogRetention(ctx).Execute()
if err != nil {
  // handle error
}
// resp is LogsRetentionResponse

Parameters

This endpoint does not need any parameter.

LogsGetLogs()

List recent notification logs for the authenticated account, newest first.

limit := float32(8.14) // float32 (optional)
cursor := "cursor_example" // string (optional)

resp, _, err := client.LogsAPI.LogsGetLogs(ctx).Limit(limit).Cursor(cursor).Execute()
if err != nil {
  // handle error
}
// resp is GetLogsResponse

Parameters

LogsGetLogsByTrackingIds()

Get logs by tracking IDs (comma-separated, max 25 IDs). Returns full log objects with personally identifiable information (recipients, user ids, phone numbers, and request details). For a simple delivery check, use Get Delivery Status.

trackingIds :=  // Comma-separated tracking IDs (URL encoded)

resp, _, err := client.LogsAPI.LogsGetLogsByTrackingIds(ctx, trackingIds).Execute()
if err != nil {
  // handle error
}
// resp is LogsGetResponse

Parameters

LogsGetLogsQueryResult()

Get results from a log query started with Start Log Query. Poll until status is Complete.

queryId :=  // Query ID returned by Start Log Query

resp, _, err := client.LogsAPI.LogsGetLogsQueryResult(ctx, queryId).Execute()
if err != nil {
  // handle error
}
// resp is LogsQueryResultResponse

Parameters

LogsRetryInbound()

Resend the EMAIL_INBOUND webhook for one inbound email. Uses the original tracking ID and does not count another email. Refused when the message is older than 30 days.

trackingId :=  // Tracking ID of the inbound email

resp, _, err := client.LogsAPI.LogsRetryInbound(ctx, trackingId).Execute()
if err != nil {
  // handle error
}
// resp is MessageResponse

Parameters

LogsStartLogsQuery()

Start an asynchronous log search over a date range. Returns a queryId; poll with Get Log Query Results until status is Complete.

logQueryPostBody := *pingram.NewLogQueryPostBody() // LogQueryPostBody

resp, _, err := client.LogsAPI.LogsStartLogsQuery(ctx).LogQueryPostBody(logQueryPostBody).Execute()
if err != nil {
  // handle error
}
// resp is LogsQueryResponse

Parameters

Request Body Properties

LogsTailLogs()

Get last 100 logs from the stream

resp, _, err := client.LogsAPI.LogsTailLogs(ctx).Execute()
if err != nil {
  // handle error
}
// resp is LogsTailResponse

Parameters

This endpoint does not need any parameter.

Numbers

NumbersList()

List active phone numbers registered for the account, including voice agent binding state.

resp, _, err := client.NumbersAPI.NumbersList(ctx).Execute()
if err != nil {
  // handle error
}
// resp is ListPhoneNumbersResponse

Parameters

This endpoint does not need any parameter.

NumbersListReleased()

List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.

resp, _, err := client.NumbersAPI.NumbersListReleased(ctx).Execute()
if err != nil {
  // handle error
}
// resp is ListReleasedPhoneNumbersResponse

Parameters

This endpoint does not need any parameter.

NumbersOrderNumber()

Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt). Pass phoneNumber in E.164 format (e.g. +15551234567).

orderPhoneNumberRequest := *pingram.NewOrderPhoneNumberRequest("PhoneNumber_example") // OrderPhoneNumberRequest

resp, _, err := client.NumbersAPI.NumbersOrderNumber(ctx).OrderPhoneNumberRequest(orderPhoneNumberRequest).Execute()
if err != nil {
  // handle error
}
// resp is OrderPhoneNumberResponse

Parameters

Request Body Properties

NumbersReleaseNumber()

Release a phone number from the account. No refund for the current billing month.

phoneNumber :=  // E.164 phone number to release

resp, _, err := client.NumbersAPI.NumbersReleaseNumber(ctx, phoneNumber).Execute()
if err != nil {
  // handle error
}
// resp is ReleasePhoneNumberResponse

Parameters

NumbersSearchAvailable()

Search for available phone numbers to purchase. Requires countryCode (e.g. US, CA). Use before ordering a number.

countryCode := "countryCode_example" // string
features := "features_example" // string (optional)
areaCode := "areaCode_example" // string (optional)
limit := float32(8.14) // float32 (optional)

resp, _, err := client.NumbersAPI.NumbersSearchAvailable(ctx).CountryCode(countryCode).Features(features).AreaCode(areaCode).Limit(limit).Execute()
if err != nil {
  // handle error
}
// resp is SearchAvailablePhoneNumbersResponse

Parameters

Profile

ProfileAcceptInvite()

Accept a team invitation using a token

acceptInviteRequest := *pingram.NewAcceptInviteRequest("Token_example") // AcceptInviteRequest

resp, _, err := client.ProfileAPI.ProfileAcceptInvite(ctx).AcceptInviteRequest(acceptInviteRequest).Execute()
if err != nil {
  // handle error
}
// resp is AcceptInviteResponse

Parameters

Request Body Properties

ProfileDeleteAccount()

Permanently delete the authenticated user’s account

deleteAccountRequest := *pingram.NewDeleteAccountRequest() // DeleteAccountRequest

resp, _, err := client.ProfileAPI.ProfileDeleteAccount(ctx).DeleteAccountRequest(deleteAccountRequest).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

Parameters

Request Body Properties

ProfileDisableMfa()

Disable MFA for the authenticated user

type_ :=  // MFA type (e.g. SOFTWARE_TOKEN_MFA)

resp, _, err := client.ProfileAPI.ProfileDisableMfa(ctx, type_).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

Parameters

ProfileGetMfaStatus()

Get MFA status for the authenticated user

resp, _, err := client.ProfileAPI.ProfileGetMfaStatus(ctx).Execute()
if err != nil {
  // handle error
}
// resp is MFAStatusResponse

Parameters

This endpoint does not need any parameter.

ProfileSetupMfa()

Start TOTP MFA setup and return QR code data

mFASetupRequest := *pingram.NewMFASetupRequest("Type_example") // MFASetupRequest

resp, _, err := client.ProfileAPI.ProfileSetupMfa(ctx).MFASetupRequest(mFASetupRequest).Execute()
if err != nil {
  // handle error
}
// resp is MFASetupResponse

Parameters

Request Body Properties

ProfileVerifyMfa()

Verify TOTP code and enable MFA

mFAVerifyRequest := *pingram.NewMFAVerifyRequest("Type_example", "Code_example", "Session_example") // MFAVerifyRequest

resp, _, err := client.ProfileAPI.ProfileVerifyMfa(ctx).MFAVerifyRequest(mFAVerifyRequest).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

Parameters

Request Body Properties

Registrations

RegistrationsCreateUs10dlcBrand()

Create a new 10DLC brand registration. Sets brandStatus to pending_review; Pingram handles carrier submission after review.

tenDlcBrandCreateRequest := *pingram.NewTenDlcBrandCreateRequest("ScenarioId_example", "BusinessType_example", "DisplayName_example", "Website_example", "Country_example", "Street_example", "City_example", "State_example", "PostalCode_example", "ComplianceContactEmail_example", "ComplianceContactPhone_example") // TenDlcBrandCreateRequest

resp, _, err := client.RegistrationsAPI.RegistrationsCreateUs10dlcBrand(ctx).TenDlcBrandCreateRequest(tenDlcBrandCreateRequest).Execute()
if err != nil {
  // handle error
}
// resp is TenDlcBrandRegistration

Parameters

Request Body Properties

RegistrationsGetUs10dlcBrand()

Get the 10DLC brand registration for the authenticated account. Returns null when no registration exists yet.

resp, _, err := client.RegistrationsAPI.RegistrationsGetUs10dlcBrand(ctx).Execute()
if err != nil {
  // handle error
}
// resp is TenDlcBrandRegistration

Parameters

This endpoint does not need any parameter.

RegistrationsGetUs10dlcCampaign()

Get the 10DLC campaign registration for the authenticated account. Returns null when no brand registration exists yet.

resp, _, err := client.RegistrationsAPI.RegistrationsGetUs10dlcCampaign(ctx).Execute()
if err != nil {
  // handle error
}
// resp is TenDlcCampaignRegistration

Parameters

This endpoint does not need any parameter.

RegistrationsUpdateUs10dlcBrand()

Overwrite business fields on this account’s existing US 10DLC brand registration (legal name, address, tax ID, website, compliance contact, and related identity). Fields you omit stay; values you send replace what was stored and are not kept as history. Does not create a registration, submit it to carriers, change brandStatus, or delete it. Workflow status stays under Pingram’s control.

tenDlcBrandUpdateRequest := *pingram.NewTenDlcBrandUpdateRequest() // TenDlcBrandUpdateRequest

resp, _, err := client.RegistrationsAPI.RegistrationsUpdateUs10dlcBrand(ctx).TenDlcBrandUpdateRequest(tenDlcBrandUpdateRequest).Execute()
if err != nil {
  // handle error
}
// resp is TenDlcBrandRegistration

Parameters

Request Body Properties

RegistrationsUpdateUs10dlcCampaign()

Overwrite campaign fields on this account’s existing US 10DLC campaign (description, samples, opt-in and opt-out text, use case, and related settings). Fields you send replace the stored values and the previous text is not kept; omitted fields stay. Editing is refused once the campaign is in_progress or approved. Does not submit the campaign to carriers, change campaignStatus, or delete it.

tenDlcCampaignUpdateRequest := *pingram.NewTenDlcCampaignUpdateRequest() // TenDlcCampaignUpdateRequest

resp, _, err := client.RegistrationsAPI.RegistrationsUpdateUs10dlcCampaign(ctx).TenDlcCampaignUpdateRequest(tenDlcCampaignUpdateRequest).Execute()
if err != nil {
  // handle error
}
// resp is TenDlcCampaignRegistration

Parameters

Request Body Properties

Sender

SenderDeleteSchedule()

Delete (unschedule) an already scheduled notification

trackingId :=  // The tracking ID of the scheduled notification

resp, _, err := client.SenderAPI.SenderDeleteSchedule(ctx, trackingId).Execute()
if err != nil {
  // handle error
}
// resp is MessageResponse

Parameters

SenderUpdateSchedule()

Update the body or schedule of an already scheduled notification.

trackingId :=  // The tracking ID of the scheduled notification
senderPostBody := *pingram.NewSenderPostBody() // SenderPostBody

resp, _, err := client.SenderAPI.SenderUpdateSchedule(ctx, trackingId).SenderPostBody(senderPostBody).Execute()
if err != nil {
  // handle error
}
// resp is MessageResponse

Parameters

Request Body Properties