Go SDK
Setup & Initialization
- Install Package:
go get github.com/pingram-io/pingram-go- Import:
import ( pingram "github.com/pingram-io/pingram-go")- Initialize:
client := pingram.NewClient("pingram_sk_your_api_key")| Name | Type | Description |
|---|---|---|
apiKey* |
string | Your Pingram API key. You can get it from your dashboard under Environments. |
baseURL |
string | Optional. Use pingram.WithBaseURL("https://api.eu.pingram.io") or pingram.WithRegion(pingram.RegionEU) for EU/CA. Default is US. |
* 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
senderPostBody := *pingram.NewSenderPostBody() // SenderPostBody
resp, _, err := client.DefaultAPI.Send(ctx).SenderPostBody(senderPostBody).Execute()if err != nil { // handle error}// resp is SenderPostResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
type |
string | ID of the notification type (e.g. “welcome_email”). Creates a new notification if it does not exist. |
to |
object | Recipient user. Provide id, email, or number to identify the user. |
to.id |
string | Unique user identifier. Required. |
to.email |
string | User’s email address for email notifications. |
to.number |
string | User’s phone number for SMS/call notifications. |
to.pushTokens |
object[] | Mobile push tokens (FCM, APN) for push notifications. |
to.pushTokens[].type |
“FCM” | “APN” | (required) |
to.pushTokens[].token |
string | (required) |
to.pushTokens[].device |
object | (required) |
to.pushTokens[].device.app_id |
string | |
to.pushTokens[].device.ad_id |
string | |
to.pushTokens[].device.device_id |
string | (required) |
to.pushTokens[].device.platform |
string | |
to.pushTokens[].device.manufacturer |
string | |
to.pushTokens[].device.model |
string | |
to.pushTokens[].environment |
string | used by APN to differentiate between sandbox and production builds (sandbox/undefined or production) |
to.webPushTokens |
object[] | Web push subscription config from the browser. |
to.webPushTokens[].sub |
object | (required) Configuration for a Push Subscription. This can be obtained on the frontend by calling serviceWorkerRegistration.pushManager.subscribe(). The expected format is the same output as JSON.stringify’ing a PushSubscription in the browser. |
to.webPushTokens[].sub.endpoint |
string | (required) |
to.webPushTokens[].sub.keys |
object | (required) |
to.webPushTokens[].sub.keys.p256dh |
string | (required) |
to.webPushTokens[].sub.keys.auth |
string | (required) |
to.timezone |
string | User’s timezone (e.g. “America/New_York”) for scheduling. |
to.slackChannel |
string | The destination channel of slack notifications sent to this user. Can be either of the following: - Channel name, e.g. “test” - Channel name with # prefix, e.g. “#test” - Channel ID, e.g. “C1234567890” - User ID for DM, e.g. “U1234567890” - Username with @ prefix, e.g. “@test” |
to.slackToken |
object | |
to.slackToken.access_token |
string | |
to.slackToken.app_id |
string | |
to.slackToken.authed_user |
object | |
to.slackToken.authed_user.access_token |
string | |
to.slackToken.authed_user.expires_in |
number | |
to.slackToken.authed_user.id |
string | |
to.slackToken.authed_user.refresh_token |
string | |
to.slackToken.authed_user.scope |
string | |
to.slackToken.authed_user.token_type |
string | |
to.slackToken.bot_user_id |
string | |
to.slackToken.enterprise |
object | |
to.slackToken.enterprise.id |
string | |
to.slackToken.enterprise.name |
string | |
to.slackToken.error |
string | |
to.slackToken.expires_in |
number | |
to.slackToken.incoming_webhook |
object | |
to.slackToken.incoming_webhook.channel |
string | |
to.slackToken.incoming_webhook.channel_id |
string | |
to.slackToken.incoming_webhook.configuration_url |
string | |
to.slackToken.incoming_webhook.url |
string | |
to.slackToken.is_enterprise_install |
boolean | |
to.slackToken.needed |
string | |
to.slackToken.ok |
boolean | (required) |
to.slackToken.provided |
string | |
to.slackToken.refresh_token |
string | |
to.slackToken.scope |
string | |
to.slackToken.team |
object | |
to.slackToken.team.id |
string | |
to.slackToken.team.name |
string | |
to.slackToken.token_type |
string | |
to.slackToken.warning |
string | |
to.slackToken.response_metadata |
object | |
to.slackToken.response_metadata.warnings |
string[] | |
to.slackToken.response_metadata.next_cursor |
string | |
to.slackToken.response_metadata.scopes |
string[] | |
to.slackToken.response_metadata.acceptedScopes |
string[] | |
to.slackToken.response_metadata.retryAfter |
number | |
to.slackToken.response_metadata.messages |
string[] | |
to.properties |
Record<string, string | number | boolean> | Custom key-value properties synced by the developer, used for audience segmentation (e.g. broadcast filters on user.properties.plan). Incremental identify calls shallow-merge keys (unset keys are preserved). Limits: max 25 keys, key length <= 64, string values <= 256 chars, serialized size <= 1KB. |
to.lastSeenTime |
string | Last activity timestamp. Updated automatically. Read-only. |
to.updatedAt |
string | Last update timestamp. Read-only. |
to.createdAt |
string | Creation timestamp. Read-only. |
to.emailSuppressionStatus |
object | Bounce or complaint status if email was suppressed. Read-only. |
to.emailSuppressionStatus.reason |
“Bounce” | “Complaint” | (required) |
to.emailSuppressionStatus.details |
object | (required) |
forceChannels |
(“EMAIL” | “INAPP_WEB” | “SMS” | “CALL” | “VOICE” | “PUSH” | “WEB_PUSH” | “SLACK”)[] | Override which channels to send to (e.g. [“EMAIL”, “SMS”]). Bypasses notification channel config. |
parameters |
Record<string, any> | Key-value pairs for template merge tags. Replaces placeholders like {{firstName}} in templates. |
templateId |
string | Specific template ID to use. If omitted, uses the default template for each channel. |
subNotificationId |
string | Sub-notification identifier (e.g. for grouping related notifications). |
options |
object | Per-channel overrides for send options (email, APN, FCM). |
options.email |
object | Email-specific overrides. |
options.email.replyToAddresses |
string[] | Reply-to addresses for the email. |
options.email.ccAddresses |
string[] | CC recipients. |
options.email.bccAddresses |
string[] | BCC recipients. |
options.email.fromAddress |
string | Override sender email address. |
options.email.fromName |
string | Override sender display name. |
options.email.openTracking |
boolean | When false, this send does not record opens and no open pixel is added. Delivery, bounce, and complaint events are unchanged. Defaults to true. |
options.email.clickTracking |
boolean | When false, links are left as written and clicks are not recorded. Delivery, bounce, and complaint events are unchanged. Defaults to true. |
options.email.attachments |
(object | object)[] | File attachments (by URL or inline base64 content). Inline content: ~4 MB raw per file (413 if exceeded). URL url: up to 20 MB per file. |
options.apn |
object | Apple Push Notification (APN) overrides. |
options.apn.expiry |
number | Seconds until the notification expires. |
options.apn.priority |
number | Delivery priority (10 = immediate, 5 = power-saving). |
options.apn.collapseId |
string | Group notifications with the same ID (replaces previous). |
options.apn.threadId |
string | Thread identifier for grouping notifications. |
options.apn.badge |
number | Badge count on app icon. |
options.apn.sound |
string | Sound file name. |
options.apn.contentAvailable |
boolean | Silent background notification (no alert). |
options.fcm |
object | Firebase Cloud Messaging (FCM) overrides. |
options.fcm.android |
object | Android-specific FCM options. |
options.fcm.android.collapseKey |
string | Collapse key for grouping messages. |
options.fcm.android.priority |
“high” | “normal” | Delivery priority. |
options.fcm.android.ttl |
number | Time to live in seconds. |
options.fcm.android.restrictedPackageName |
string | Restrict delivery to a specific package. |
options.push |
object | Cross-platform mobile push options (applied to both APN and FCM). |
options.push.customData |
Record<string, string> | Up to 3 custom string key-value pairs for deep linking. Included in both APN and FCM payloads. |
schedule |
string | |
email |
object | Inline email content (subject, html). Use when not using templates. |
email.subject |
string | (required) Email subject line. |
email.html |
string | (required) HTML body content. |
email.previewText |
string | Preview/snippet text shown in inbox. |
email.senderName |
string | Display name of sender. |
email.senderEmail |
string | Sender email address. |
inapp |
object | Inline in-app content (title, url, image). |
inapp.title |
string | (required) Notification title. |
inapp.url |
string | URL to open when clicked. |
inapp.image |
string | Image URL. |
sms |
object | Inline SMS content (message, from, mediaUrls). |
sms.message |
string | SMS/MMS body text. |
sms.mediaUrls |
string[] | Public HTTPS URLs of media to attach (MMS). Carriers fetch these via GET. Total size limits apply per provider. |
sms.from |
string | Override the sender phone number. Must be a verified number on your account. |
call |
object | Inline call content (message). |
call.message |
string | (required) Text to speak (TTS). |
web_push |
object | Inline web push content (title, message, icon, url). |
web_push.title |
string | (required) Notification title. |
web_push.message |
string | (required) Body text. |
web_push.icon |
string | Icon URL. |
web_push.url |
string | URL to open when clicked. |
mobile_push |
object | Inline mobile push content (title, message). |
mobile_push.title |
string | (required) Notification title. |
mobile_push.message |
string | (required) Body text. |
slack |
object | Inline Slack content (text, blocks, etc.). |
slack.text |
string | (required) Fallback plain text (required when using blocks). |
slack.blocks |
Record<string, any>[] | Slack Block Kit blocks. |
slack.username |
string | Override bot username. |
slack.icon |
string | Icon: emoji (e.g. “:smile:”) or URL. Default: bot’s icon. |
slack.thread_ts |
string | Parent message ts to post in a thread. |
slack.reply_broadcast |
boolean | When true with thread_ts, broadcasts reply to channel. Default: false. |
slack.parse |
“full” | “none” | URL parsing: “full” (clickable links) or “none”. Default: “none”. |
slack.link_names |
boolean | Convert channel and username refs to Slack links. Default: false. |
slack.mrkdwn |
boolean | Enable Slack markup (bold, italic, code). Default: true. |
slack.unfurl_links |
boolean | Unfurl link previews. Default: true. |
slack.unfurl_media |
boolean | Unfurl media previews. Default: true. |
slack.metadata |
object | Slack message metadata with optional work object entities. Combines standard Slack message metadata fields with an array of entity objects. |
slack.metadata.entities |
object[] | An array of work object entities. |
slack.metadata.entities[].entity_type |
string | (required) Entity type (e.g., ‘slack#/entities/task’, ‘slack#/entities/file’). |
slack.metadata.entities[].entity_payload |
Record<string, any> | (required) Schema for the given entity type. |
slack.metadata.entities[].external_ref |
object | (required) Reference used to identify an entity within the developer’s system. |
slack.metadata.entities[].external_ref.id |
string | (required) |
slack.metadata.entities[].external_ref.type |
string | |
slack.metadata.entities[].url |
string | (required) URL used to identify an entity within the developer’s system. |
slack.metadata.entities[].app_unfurl_url |
string | The exact URL posted in the source message. Required in metadata passed to chat.unfurl. |
slack.metadata.event_type |
string | A human readable alphanumeric string representing your application’s metadata event. |
slack.metadata.event_payload |
Record<string, any> | A free-form object containing whatever data your application wishes to attach to messages. |
Webhooks
WebhooksCreateWebhook()
Create a webhook endpoint on a server outside Pingram
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 WebhookEndpointParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
webhook |
string | (required) Public HTTPS URL that accepts POST with a JSON event body. Return 2xx to acknowledge. Private, loopback, and link-local addresses are rejected. Requests include X-Pingram-Id, X-Pingram-Signature (v1 HMAC-SHA256), and X-Pingram-Timestamp. A username and password in this URL are stored separately and removed from the saved URL. |
events |
(“EMAIL_OPEN” | “EMAIL_CLICK” | “EMAIL_FAILED” | “EMAIL_DELIVERED” | “EMAIL_UNSUBSCRIBE” | “EMAIL_INBOUND” | “INAPP_WEB_FAILED” | “INAPP_WEB_UNSUBSCRIBE” | “SMS_DELIVERED” | “SMS_FAILED” | “SMS_UNSUBSCRIBE” | “SMS_SUBSCRIBE” | “SMS_INBOUND” | “VOICE_INBOUND” | “VOICE_CONNECTED” | “VOICE_ENDED” | “PUSH_FAILED” | “PUSH_UNSUBSCRIBE” | “CALL_FAILED” | “CALL_UNSUBSCRIBE” | “WEB_PUSH_FAILED” | “WEB_PUSH_UNSUBSCRIBE” | “SLACK_FAILED” | “SLACK_UNSUBSCRIBE” | “ACCOUNT_USAGE”)[] | (required) Full set of event types to deliver to this URL. Omitting an event on update unsubscribes it. Inbound SMS to the free shared number only works when that person has already received a text from this number. Inbound SMS to a dedicated number works normally. |
basicAuth |
object | HTTP Basic credentials. Omit to leave stored credentials unchanged. null removes them. Do not also put credentials in the webhook URL. The password is write-only. |
basicAuth.username |
string | (required) Username for the Authorization header. |
basicAuth.password |
string | Password for the Authorization header. Required when setting basic auth. Omit on update to keep the stored password. |
WebhooksDeleteWebhook()
Delete one webhook endpoint by id from list or create
endpointId := // Id of the webhook endpoint, from list or create.
_, err := client.WebhooksAPI.WebhooksDeleteWebhook(ctx, endpointId).Execute()if err != nil { // handle error}Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| endpointId | string | Id of the webhook endpoint, from list or create. | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
WebhooksListWebhooks()
List webhook endpoints
resp, _, err := client.WebhooksAPI.WebhooksListWebhooks(ctx).Execute()if err != nil { // handle error}// resp is WebhookEndpointsResponseParameters
This endpoint does not need any parameter.
WebhooksUpdateWebhook()
Replace a webhook endpoint
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 WebhookEndpointParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| endpointId | string | Id of the webhook endpoint, from list or create. | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
webhook |
string | (required) Public HTTPS URL that accepts POST with a JSON event body. Return 2xx to acknowledge. Private, loopback, and link-local addresses are rejected. Requests include X-Pingram-Id, X-Pingram-Signature (v1 HMAC-SHA256), and X-Pingram-Timestamp. A username and password in this URL are stored separately and removed from the saved URL. |
events |
(“EMAIL_OPEN” | “EMAIL_CLICK” | “EMAIL_FAILED” | “EMAIL_DELIVERED” | “EMAIL_UNSUBSCRIBE” | “EMAIL_INBOUND” | “INAPP_WEB_FAILED” | “INAPP_WEB_UNSUBSCRIBE” | “SMS_DELIVERED” | “SMS_FAILED” | “SMS_UNSUBSCRIBE” | “SMS_SUBSCRIBE” | “SMS_INBOUND” | “VOICE_INBOUND” | “VOICE_CONNECTED” | “VOICE_ENDED” | “PUSH_FAILED” | “PUSH_UNSUBSCRIBE” | “CALL_FAILED” | “CALL_UNSUBSCRIBE” | “WEB_PUSH_FAILED” | “WEB_PUSH_UNSUBSCRIBE” | “SLACK_FAILED” | “SLACK_UNSUBSCRIBE” | “ACCOUNT_USAGE”)[] | (required) Full set of event types to deliver to this URL. Omitting an event on update unsubscribes it. Inbound SMS to the free shared number only works when that person has already received a text from this number. Inbound SMS to a dedicated number works normally. |
basicAuth |
object | HTTP Basic credentials. Omit to leave stored credentials unchanged. null removes them. Do not also put credentials in the webhook URL. The password is write-only. |
basicAuth.username |
string | (required) Username for the Authorization header. |
basicAuth.password |
string | Password for the Authorization header. Required when setting basic auth. Omit on update to keep the stored password. |
Accounts
AccountsCreateAccount()
Create another Pingram account
createAccountRequest := *pingram.NewCreateAccountRequest("Name_example") // CreateAccountRequest
resp, _, err := client.AccountsAPI.AccountsCreateAccount(ctx).CreateAccountRequest(createAccountRequest).Execute()if err != nil { // handle error}// resp is CreateAccountResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
name |
string | (required) |
plan |
object | Billing to copy onto a new additional account. |
plan.tier |
“budget_20” | “budget_50” | “budget_100” | “budget_250” | “budget_500” | “budget_1000” | (required) |
plan.sourceBillingAccountId |
string | (required) Account whose saved payment method is copied onto the new account. The caller must be an owner of this account. |
memberEmails |
string[] | Emails to add or invite to the new account. Existing members of any account the caller belongs to are added directly; everyone else is invited. |
AccountsListAccounts()
List accounts the authenticated user can access
resp, _, err := client.AccountsAPI.AccountsListAccounts(ctx).Execute()if err != nil { // handle error}// resp is ListAccountsResponseParameters
This endpoint does not need any parameter.
AccountsUpdateAccount()
Change the display name of an account
accountId := // Account to renameupdateAccountRequest := *pingram.NewUpdateAccountRequest("Name_example") // UpdateAccountRequest
resp, _, err := client.AccountsAPI.AccountsUpdateAccount(ctx, accountId).UpdateAccountRequest(updateAccountRequest).Execute()if err != nil { // handle error}// resp is AccountSummaryParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account to rename | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
name |
string | (required) Display name for this account. |
Broadcasts
BroadcastsArchive()
Archive an email broadcast
broadcastId := // Broadcast ID
resp, _, err := client.BroadcastsAPI.BroadcastsArchive(ctx, broadcastId).Execute()if err != nil { // handle error}// resp is BroadcastResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
BroadcastsCancel()
Cancel an email broadcast
broadcastId := // Broadcast ID
resp, _, err := client.BroadcastsAPI.BroadcastsCancel(ctx, broadcastId).Execute()if err != nil { // handle error}// resp is BroadcastResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
BroadcastsCreate()
Create a draft email broadcast
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 BroadcastResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
name |
string | (required) |
type |
string | Notification type id. Optional on create; required before send/schedule. Created on the fly when missing. |
channel |
“email” | |
audience |
object | (required) Broadcast audience: exactly one of filter (Mongo-style query evaluated against synced user objects) or emails (raw list, max 10,000 addresses; for larger audiences use filter after syncing users via the Users API). |
audience.filter |
Record<string, any> | |
audience.emails |
string[] | |
fromName |
string | (required) |
fromAddress |
string | (required) From address. Use an address on a domain verified for this account to email other people. The shared address noreply@pingram.email can send a test broadcast only to your own account email as the sole recipient. Verify a domain to send to a wider audience. |
replyToAddress |
string | |
subject |
string | (required) |
html |
string | (required) |
internalTemplate |
string | Optional visual-editor source. Pair with html. A later update can add it to a draft by sending it with html. |
BroadcastsDelete()
Delete an email broadcast
broadcastId := // Broadcast ID
resp, _, err := client.BroadcastsAPI.BroadcastsDelete(ctx, broadcastId).Execute()if err != nil { // handle error}// resp is MessageResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
BroadcastsGet()
Get one email broadcast by ID
broadcastId := // Broadcast ID
resp, _, err := client.BroadcastsAPI.BroadcastsGet(ctx, broadcastId).Execute()if err != nil { // handle error}// resp is BroadcastResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
BroadcastsGetMetrics()
Get live broadcast metrics
broadcastId := // Broadcast ID
resp, _, err := client.BroadcastsAPI.BroadcastsGetMetrics(ctx, broadcastId).Execute()if err != nil { // handle error}// resp is BroadcastMetricsResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
BroadcastsList()
List email broadcasts for the account, newest first
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 ListBroadcastsResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | float32 | Max broadcasts to return (default 50) | |
| nextToken | string | Pagination token |
BroadcastsListRecipients()
List email broadcast recipients
broadcastId := // Broadcast IDstatus := "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 ListBroadcastRecipientsResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
status | string | Filter | limit | float32 | Max recipients to return (default 50) | nextToken | string | Pagination token |
BroadcastsPause()
Pause an actively sending email broadcast
broadcastId := // Broadcast ID
resp, _, err := client.BroadcastsAPI.BroadcastsPause(ctx, broadcastId).Execute()if err != nil { // handle error}// resp is BroadcastResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
BroadcastsResume()
Resume a paused email broadcast
broadcastId := // Broadcast ID
resp, _, err := client.BroadcastsAPI.BroadcastsResume(ctx, broadcastId).Execute()if err != nil { // handle error}// resp is BroadcastResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
BroadcastsSchedule()
Schedule a draft email broadcast for a future ISO datetime
broadcastId := // Broadcast IDscheduleBroadcastRequest := *pingram.NewScheduleBroadcastRequest("SendAt_example") // ScheduleBroadcastRequest
resp, _, err := client.BroadcastsAPI.BroadcastsSchedule(ctx, broadcastId).ScheduleBroadcastRequest(scheduleBroadcastRequest).Execute()if err != nil { // handle error}// resp is BroadcastResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
sendAt |
string | (required) ISO datetime in the future. |
BroadcastsSend()
Send a draft email broadcast immediately
broadcastId := // Broadcast ID
resp, _, err := client.BroadcastsAPI.BroadcastsSend(ctx, broadcastId).Execute()if err != nil { // handle error}// resp is BroadcastResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
BroadcastsUnarchive()
Restore an archived email broadcast
broadcastId := // Broadcast ID
resp, _, err := client.BroadcastsAPI.BroadcastsUnarchive(ctx, broadcastId).Execute()if err != nil { // handle error}// resp is BroadcastResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
BroadcastsUpdate()
Update a draft email broadcast
broadcastId := // Broadcast IDupdateBroadcastRequest := *pingram.NewUpdateBroadcastRequest() // UpdateBroadcastRequest
resp, _, err := client.BroadcastsAPI.BroadcastsUpdate(ctx, broadcastId).UpdateBroadcastRequest(updateBroadcastRequest).Execute()if err != nil { // handle error}// resp is BroadcastResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| broadcastId | string | Broadcast ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
name |
string | |
type |
string | |
channel |
“email” | |
audience |
object | Broadcast audience: exactly one of filter (Mongo-style query evaluated against synced user objects) or emails (raw list, max 10,000 addresses; for larger audiences use filter after syncing users via the Users API). |
audience.filter |
Record<string, any> | |
audience.emails |
string[] | |
fromName |
string | |
fromAddress |
string | From address. Use an address on a domain verified for this account to email other people. The shared address noreply@pingram.email can send a test broadcast only to your own account email as the sole recipient. Verify a domain to send to a wider audience. |
replyToAddress |
string | Omit to leave unchanged. Empty string clears Reply-To. |
subject |
string | |
html |
string | |
internalTemplate |
string | Visual-editor source. Send with html to add it to an html-only draft or to update it. Cannot be removed. |
Domains
DomainsAddDomain()
Start verification for a domain you already own
postSendersRequestBody := *pingram.NewPostSendersRequestBody("Sender_example") // PostSendersRequestBody
resp, _, err := client.DomainsAPI.DomainsAddDomain(ctx).PostSendersRequestBody(postSendersRequestBody).Execute()if err != nil { // handle error}// resp is []GetSendersResponseInnerParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
sender |
string | (required) |
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 SuccessResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| sender | string | Sender domain (URL encoded) | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
DomainsListDomains()
List domains already added to this Pingram account for email
resp, _, err := client.DomainsAPI.DomainsListDomains(ctx).Execute()if err != nil { // handle error}// resp is []GetSendersResponseInnerParameters
This endpoint does not need any parameter.
DomainsStartDomainVerification()
Start domain verification
sender := // Sender domain (URL encoded)
resp, _, err := client.DomainsAPI.DomainsStartDomainVerification(ctx, sender).Execute()if err != nil { // handle error}// resp is []GetSendersResponseInnerParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| sender | string | Sender domain (URL encoded) | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
EmailDeleteSuppressions()
Remove email suppressions
reason := // Suppression reason to clear (retryable | bounces)
resp, _, err := client.EmailAPI.EmailDeleteSuppressions(ctx, reason).Execute()if err != nil { // handle error}// resp is MessageResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| reason | string | Suppression reason to clear (retryable | bounces) |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
EmailSend()
Send an email
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 SendEmailApiResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
type |
string | (required) The notification type to send. |
to |
string | (required) The email address of the recipient. |
subject |
string | (required) The subject of the email. |
html |
string | (required) The HTML body of the email. |
fromName |
string | The display name of the sender. |
fromAddress |
string | The email address of the sender. |
previewText |
string | The preview text of the email. |
replyToAddresses |
string[] | The reply-to addresses of the email. |
ccAddresses |
string[] | The CC addresses of the email. |
bccAddresses |
string[] | The BCC addresses of the email. |
openTracking |
boolean | When false, this send does not record opens and no open pixel is added. Delivery, bounce, and complaint events are unchanged. Defaults to true. |
clickTracking |
boolean | When false, links are left as written and clicks are not recorded. Delivery, bounce, and complaint events are unchanged. Defaults to true. |
attachments |
object[] | URL-based file attachments. Up to 20 MB per file. |
attachments[].filename |
string | (required) |
attachments[].url |
string | (required) |
schedule |
string | The ISO 8601 datetime to schedule the email. |
Environments
EnvironmentsListEnvironments()
Get all environments for the authenticated account
resp, _, err := client.EnvironmentsAPI.EnvironmentsListEnvironments(ctx).Execute()if err != nil { // handle error}// resp is []GetEnvironmentsResponseInnerParameters
This endpoint does not need any parameter.
EnvironmentsUpdateEnvironment()
Update environment settings
clientId := // Environment client IDenvironmentPatchRequest := *pingram.NewEnvironmentPatchRequest() // EnvironmentPatchRequest
resp, _, err := client.EnvironmentsAPI.EnvironmentsUpdateEnvironment(ctx, clientId).EnvironmentPatchRequest(environmentPatchRequest).Execute()if err != nil { // handle error}// resp is EnvironmentParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| clientId | string | Environment client ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
resetSecret |
boolean | |
disableSending |
(“EMAIL” | “INAPP_WEB” | “SMS” | “CALL” | “VOICE” | “PUSH” | “WEB_PUSH” | “SLACK”)[] | |
title |
string | |
secureMode |
boolean |
Library
LibraryCreate()
Create an upload slot in the account library
useCase := // Library use-casecreateLibraryRequest := *pingram.NewCreateLibraryRequest("Filename_example", "ContentType_example") // CreateLibraryRequest
resp, _, err := client.LibraryAPI.LibraryCreate(ctx, useCase).CreateLibraryRequest(createLibraryRequest).Execute()if err != nil { // handle error}// resp is CreateLibraryResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| useCase | string | Library use-case | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
filename |
string | (required) Original filename, including extension (e.g. hero.png). |
contentType |
string | (required) Image MIME type. One of image/png, image/jpeg, image/gif, or image/webp. |
LibraryList()
List files in the account library
useCase := // Library use-caselimit := 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 ListLibraryResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| useCase | string | Library use-case | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
limit | float32 | Max items to return (default 50) | nextToken | string | Pagination token |
Logs
LogsGetDeliveryStatus()
Look up email and SMS delivery status
trackingIds := // Comma-separated tracking IDs (URL encoded, max 25)
resp, _, err := client.LogsAPI.LogsGetDeliveryStatus(ctx, trackingIds).Execute()if err != nil { // handle error}// resp is LogsDeliveryStatusResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| trackingIds | string | Comma-separated tracking IDs (URL encoded, max 25) | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
LogsGetLogRetention()
Get log retention period in days for the account
resp, _, err := client.LogsAPI.LogsGetLogRetention(ctx).Execute()if err != nil { // handle error}// resp is LogsRetentionResponseParameters
This endpoint does not need any parameter.
LogsGetLogs()
List recent notification logs
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 GetLogsResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | float32 | Maximum number of logs to return (default | |
| cursor | string | Pagination cursor for next page |
LogsGetLogsByTrackingIds()
Get logs by tracking IDs (comma-separated, max 25 IDs)
trackingIds := // Comma-separated tracking IDs (URL encoded)
resp, _, err := client.LogsAPI.LogsGetLogsByTrackingIds(ctx, trackingIds).Execute()if err != nil { // handle error}// resp is LogsGetResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| trackingIds | string | Comma-separated tracking IDs (URL encoded) | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
LogsGetLogsQueryResult()
Get results from a log query started with Start Log Query
queryId := // Query ID returned by Start Log Query
resp, _, err := client.LogsAPI.LogsGetLogsQueryResult(ctx, queryId).Execute()if err != nil { // handle error}// resp is LogsQueryResultResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| queryId | string | Query ID returned by Start Log Query | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
LogsRetryInbound()
Resend the EMAIL_INBOUND webhook for one inbound email
trackingId := // Tracking ID of the inbound email
resp, _, err := client.LogsAPI.LogsRetryInbound(ctx, trackingId).Execute()if err != nil { // handle error}// resp is MessageResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| trackingId | string | Tracking ID of the inbound email | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
LogsStartLogsQuery()
Start an asynchronous log search over a date range
logQueryPostBody := *pingram.NewLogQueryPostBody() // LogQueryPostBody
resp, _, err := client.LogsAPI.LogsStartLogsQuery(ctx).LogQueryPostBody(logQueryPostBody).Execute()if err != nil { // handle error}// resp is LogsQueryResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
dateRangeFilter |
number[] | A tuple of [startTime, endTime] for the date range filter, each representing a unix timestamp. |
userFilter |
string | |
envIdFilter |
string[] | |
statusFilter |
string | |
channelFilter |
(“email” | “inapp” | “sms” | “call” | “voice” | “web_push” | “mobile_push” | “slack”)[] | |
notificationFilter |
string[] |
LogsTailLogs()
Get last 100 logs from the stream
resp, _, err := client.LogsAPI.LogsTailLogs(ctx).Execute()if err != nil { // handle error}// resp is LogsTailResponseParameters
This endpoint does not need any parameter.
Numbers
NumbersList()
List phone numbers
resp, _, err := client.NumbersAPI.NumbersList(ctx).Execute()if err != nil { // handle error}// resp is ListPhoneNumbersResponseParameters
This endpoint does not need any parameter.
NumbersListReleased()
List released phone numbers
resp, _, err := client.NumbersAPI.NumbersListReleased(ctx).Execute()if err != nil { // handle error}// resp is ListReleasedPhoneNumbersResponseParameters
This endpoint does not need any parameter.
NumbersOrderNumber()
Purchase a phone number
orderPhoneNumberRequest := *pingram.NewOrderPhoneNumberRequest("PhoneNumber_example") // OrderPhoneNumberRequest
resp, _, err := client.NumbersAPI.NumbersOrderNumber(ctx).OrderPhoneNumberRequest(orderPhoneNumberRequest).Execute()if err != nil { // handle error}// resp is OrderPhoneNumberResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
phoneNumber |
string | (required) E.164 from search results |
NumbersReleaseNumber()
Release a phone number from the account
phoneNumber := // E.164 phone number to release
resp, _, err := client.NumbersAPI.NumbersReleaseNumber(ctx, phoneNumber).Execute()if err != nil { // handle error}// resp is ReleasePhoneNumberResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| phoneNumber | string | E.164 phone number to release | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
NumbersSearchAvailable()
Search for available phone numbers to purchase
countryCode := "countryCode_example" // stringfeatures := "features_example" // string (optional)areaCode := "areaCode_example" // string (optional)limit := float32(8.14) // float32 (optional)startsWith := "startsWith_example" // string (optional)endsWith := "endsWith_example" // string (optional)contains := "contains_example" // string (optional)city := "city_example" // string (optional)
resp, _, err := client.NumbersAPI.NumbersSearchAvailable(ctx).CountryCode(countryCode).Features(features).AreaCode(areaCode).Limit(limit).StartsWith(startsWith).EndsWith(endsWith).Contains(contains).City(city).Execute()if err != nil { // handle error}// resp is SearchAvailablePhoneNumbersResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| countryCode | string | ISO 3166-1 alpha-2 country code (e.g., US, CA) | |
| features | string | Comma-separated | |
| areaCode | string | National destination / area code filter | |
| limit | float32 | Max results (default 10, max 50) | |
| startsWith | string | Digits the number starts with, 1 to 7 digits. Do not include the country code. When `areaCode` is set, omit those digits here. | |
| endsWith | string | Digits the number must end with, 1 to 7 digits. Use this to find a number close to one you already have. | |
| contains | string | Digits to find in the number, in that order, 1 to 7 digits. | |
| city | string | City to search in, such as San Francisco. |
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 AcceptInviteResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
token |
string | (required) |
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 SuccessResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
reason |
string |
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 SuccessResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| type_ | string | MFA type (e.g. SOFTWARE_TOKEN_MFA) | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
ProfileGetMfaStatus()
Get MFA status for the authenticated user
resp, _, err := client.ProfileAPI.ProfileGetMfaStatus(ctx).Execute()if err != nil { // handle error}// resp is MFAStatusResponseParameters
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 MFASetupResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
type |
“SOFTWARE_TOKEN_MFA” | (required) MFA methods supported by the profile MFA API. |
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 SuccessResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
type |
“SOFTWARE_TOKEN_MFA” | (required) MFA methods supported by the profile MFA API. |
code |
string | (required) |
session |
string | (required) |
Registrations
RegistrationsCreateUs10dlcBrand()
Create a new 10DLC brand registration
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 TenDlcBrandRegistrationParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
scenarioId |
“own_brand” | “client_brand” | (required) Who the 10DLC brand is registered for. - own_brand: personal or company project - client_brand: agency or contractor |
businessType |
“PRIVATE_PROFIT” | “SOLE_PROPRIETOR” | “PUBLIC_PROFIT” | “NON_PROFIT” | “GOVERNMENT” | (required) Legal entity type for a 10DLC brand. - PRIVATE_PROFIT: private for-profit (LLC, corp, etc.) - SOLE_PROPRIETOR: sole proprietorship - PUBLIC_PROFIT: publicly traded for-profit - NON_PROFIT: non-profit - GOVERNMENT: government |
legalName |
string | Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName). |
displayName |
string | (required) Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For companies with no DBA, use the same value as legalName. For SOLE_PROPRIETOR, this is the brand you send as — not the individual’s legal name (set firstName and lastName for that). If the sole proprietor has no DBA, use first and last name. |
firstName |
string | Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR. |
lastName |
string | Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR. |
taxId |
string | For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Required except when businessType is SOLE_PROPRIETOR. |
website |
string | (required) Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms. |
country |
string | (required) ISO 3166-1 alpha-2 country of incorporation (for example US or CA). |
street |
string | (required) Street address that matches official tax registration. |
city |
string | (required) City that matches official tax registration. |
state |
string | (required) State (US) or province (CA) that matches official tax registration. |
postalCode |
string | (required) ZIP code (US) or postal code (CA) that matches official tax registration. |
complianceContactEmail |
string | (required) Email for the 10DLC compliance contact. Used for carrier and registration follow-up. |
complianceContactPhone |
string | (required) Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country. |
RegistrationsGetUs10dlcBrand()
Get the 10DLC brand registration
resp, _, err := client.RegistrationsAPI.RegistrationsGetUs10dlcBrand(ctx).Execute()if err != nil { // handle error}// resp is TenDlcBrandRegistrationParameters
This endpoint does not need any parameter.
RegistrationsGetUs10dlcCampaign()
Get the 10DLC campaign registration
resp, _, err := client.RegistrationsAPI.RegistrationsGetUs10dlcCampaign(ctx).Execute()if err != nil { // handle error}// resp is TenDlcCampaignRegistrationParameters
This endpoint does not need any parameter.
RegistrationsUpdateUs10dlcBrand()
Update the 10DLC brand
tenDlcBrandUpdateRequest := *pingram.NewTenDlcBrandUpdateRequest() // TenDlcBrandUpdateRequest
resp, _, err := client.RegistrationsAPI.RegistrationsUpdateUs10dlcBrand(ctx).TenDlcBrandUpdateRequest(tenDlcBrandUpdateRequest).Execute()if err != nil { // handle error}// resp is TenDlcBrandRegistrationParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
scenarioId |
“own_brand” | “client_brand” | Who the 10DLC brand is registered for. - own_brand: personal or company project - client_brand: agency or contractor |
businessType |
“PRIVATE_PROFIT” | “SOLE_PROPRIETOR” | “PUBLIC_PROFIT” | “NON_PROFIT” | “GOVERNMENT” | Legal entity type for a 10DLC brand. - PRIVATE_PROFIT: private for-profit (LLC, corp, etc.) - SOLE_PROPRIETOR: sole proprietorship - PUBLIC_PROFIT: publicly traded for-profit - NON_PROFIT: non-profit - GOVERNMENT: government |
legalName |
string | Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName). |
displayName |
string | Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For SOLE_PROPRIETOR, this is the brand you send as — not the individual’s legal name. Omit to keep the existing value. If you change legalName and omit displayName, displayName is reset to the new legalName. |
firstName |
string | Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR. |
lastName |
string | Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR. |
taxId |
string | For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Required except when businessType is SOLE_PROPRIETOR. |
website |
string | Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms. |
country |
string | ISO 3166-1 alpha-2 country of incorporation (for example US or CA). |
street |
string | Street address that matches official tax registration. |
city |
string | City that matches official tax registration. |
state |
string | State (US) or province (CA) that matches official tax registration. |
postalCode |
string | ZIP code (US) or postal code (CA) that matches official tax registration. |
complianceContactEmail |
string | Email for the 10DLC compliance contact. Used for carrier and registration follow-up. |
complianceContactPhone |
string | Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country. |
RegistrationsUpdateUs10dlcCampaign()
Update the 10DLC campaign
tenDlcCampaignUpdateRequest := *pingram.NewTenDlcCampaignUpdateRequest() // TenDlcCampaignUpdateRequest
resp, _, err := client.RegistrationsAPI.RegistrationsUpdateUs10dlcCampaign(ctx).TenDlcCampaignUpdateRequest(tenDlcCampaignUpdateRequest).Execute()if err != nil { // handle error}// resp is TenDlcCampaignRegistrationParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
campaignDescription |
string | Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission. |
campaignSample1 |
string | Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language. |
campaignSample2 |
string | Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases. |
campaignSample3 |
string | Optional third example SMS. |
campaignSample4 |
string | Optional fourth example SMS. |
campaignMessageFlow |
string | How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission. |
campaignOptinKeywords |
string | Extra opt-in keywords as a comma-separated list. START is always included. |
campaignOptinMessage |
string | Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions. |
campaignOptoutKeywords |
string | Extra opt-out keywords as a comma-separated list. STOP is always included. |
campaignOptoutMessage |
string | Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages. |
campaignHelpKeywords |
string | Extra help keywords as a comma-separated list. HELP is always included. |
campaignHelpMessage |
string | Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone). |
campaignEmbeddedLink |
boolean | Whether campaign messages include URLs. |
campaignEmbeddedLinkUrl |
string | Sample URL that appears in messages. Provide when campaignEmbeddedLink is true. |
campaignEmbeddedPhone |
boolean | Whether campaign messages include phone numbers. |
campaignAgeGated |
boolean | Whether campaign content is age-restricted (18+). |
campaignDirectLending |
boolean | Whether the campaign relates to direct lending or loan products. |
campaignPrivacyPolicyLink |
string | Public URL of the privacy policy that covers this SMS program. |
campaignTermsAndConditionsLink |
string | Public URL of the terms and conditions that cover this SMS program. |
campaignUsecase |
string | 10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION. |
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 MessageResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| trackingId | string | The tracking ID of the scheduled notification | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
SenderUpdateSchedule()
Update a scheduled notification
trackingId := // The tracking ID of the scheduled notificationsenderPostBody := *pingram.NewSenderPostBody() // SenderPostBody
resp, _, err := client.SenderAPI.SenderUpdateSchedule(ctx, trackingId).SenderPostBody(senderPostBody).Execute()if err != nil { // handle error}// resp is MessageResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| trackingId | string | The tracking ID of the scheduled notification | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
type |
string | ID of the notification type (e.g. “welcome_email”). Creates a new notification if it does not exist. |
to |
object | Recipient user. Provide id, email, or number to identify the user. |
to.id |
string | Unique user identifier. Required. |
to.email |
string | User’s email address for email notifications. |
to.number |
string | User’s phone number for SMS/call notifications. |
to.pushTokens |
object[] | Mobile push tokens (FCM, APN) for push notifications. |
to.pushTokens[].type |
“FCM” | “APN” | (required) |
to.pushTokens[].token |
string | (required) |
to.pushTokens[].device |
object | (required) |
to.pushTokens[].device.app_id |
string | |
to.pushTokens[].device.ad_id |
string | |
to.pushTokens[].device.device_id |
string | (required) |
to.pushTokens[].device.platform |
string | |
to.pushTokens[].device.manufacturer |
string | |
to.pushTokens[].device.model |
string | |
to.pushTokens[].environment |
string | used by APN to differentiate between sandbox and production builds (sandbox/undefined or production) |
to.webPushTokens |
object[] | Web push subscription config from the browser. |
to.webPushTokens[].sub |
object | (required) Configuration for a Push Subscription. This can be obtained on the frontend by calling serviceWorkerRegistration.pushManager.subscribe(). The expected format is the same output as JSON.stringify’ing a PushSubscription in the browser. |
to.webPushTokens[].sub.endpoint |
string | (required) |
to.webPushTokens[].sub.keys |
object | (required) |
to.webPushTokens[].sub.keys.p256dh |
string | (required) |
to.webPushTokens[].sub.keys.auth |
string | (required) |
to.timezone |
string | User’s timezone (e.g. “America/New_York”) for scheduling. |
to.slackChannel |
string | The destination channel of slack notifications sent to this user. Can be either of the following: - Channel name, e.g. “test” - Channel name with # prefix, e.g. “#test” - Channel ID, e.g. “C1234567890” - User ID for DM, e.g. “U1234567890” - Username with @ prefix, e.g. “@test” |
to.slackToken |
object | |
to.slackToken.access_token |
string | |
to.slackToken.app_id |
string | |
to.slackToken.authed_user |
object | |
to.slackToken.authed_user.access_token |
string | |
to.slackToken.authed_user.expires_in |
number | |
to.slackToken.authed_user.id |
string | |
to.slackToken.authed_user.refresh_token |
string | |
to.slackToken.authed_user.scope |
string | |
to.slackToken.authed_user.token_type |
string | |
to.slackToken.bot_user_id |
string | |
to.slackToken.enterprise |
object | |
to.slackToken.enterprise.id |
string | |
to.slackToken.enterprise.name |
string | |
to.slackToken.error |
string | |
to.slackToken.expires_in |
number | |
to.slackToken.incoming_webhook |
object | |
to.slackToken.incoming_webhook.channel |
string | |
to.slackToken.incoming_webhook.channel_id |
string | |
to.slackToken.incoming_webhook.configuration_url |
string | |
to.slackToken.incoming_webhook.url |
string | |
to.slackToken.is_enterprise_install |
boolean | |
to.slackToken.needed |
string | |
to.slackToken.ok |
boolean | (required) |
to.slackToken.provided |
string | |
to.slackToken.refresh_token |
string | |
to.slackToken.scope |
string | |
to.slackToken.team |
object | |
to.slackToken.team.id |
string | |
to.slackToken.team.name |
string | |
to.slackToken.token_type |
string | |
to.slackToken.warning |
string | |
to.slackToken.response_metadata |
object | |
to.slackToken.response_metadata.warnings |
string[] | |
to.slackToken.response_metadata.next_cursor |
string | |
to.slackToken.response_metadata.scopes |
string[] | |
to.slackToken.response_metadata.acceptedScopes |
string[] | |
to.slackToken.response_metadata.retryAfter |
number | |
to.slackToken.response_metadata.messages |
string[] | |
to.properties |
Record<string, string | number | boolean> | Custom key-value properties synced by the developer, used for audience segmentation (e.g. broadcast filters on user.properties.plan). Incremental identify calls shallow-merge keys (unset keys are preserved). Limits: max 25 keys, key length <= 64, string values <= 256 chars, serialized size <= 1KB. |
to.lastSeenTime |
string | Last activity timestamp. Updated automatically. Read-only. |
to.updatedAt |
string | Last update timestamp. Read-only. |
to.createdAt |
string | Creation timestamp. Read-only. |
to.emailSuppressionStatus |
object | Bounce or complaint status if email was suppressed. Read-only. |
to.emailSuppressionStatus.reason |
“Bounce” | “Complaint” | (required) |
to.emailSuppressionStatus.details |
object | (required) |
forceChannels |
(“EMAIL” | “INAPP_WEB” | “SMS” | “CALL” | “VOICE” | “PUSH” | “WEB_PUSH” | “SLACK”)[] | Override which channels to send to (e.g. [“EMAIL”, “SMS”]). Bypasses notification channel config. |
parameters |
Record<string, any> | Key-value pairs for template merge tags. Replaces placeholders like {{firstName}} in templates. |
templateId |
string | Specific template ID to use. If omitted, uses the default template for each channel. |
subNotificationId |
string | Sub-notification identifier (e.g. for grouping related notifications). |
options |
object | Per-channel overrides for send options (email, APN, FCM). |
options.email |
object | Email-specific overrides. |
options.email.replyToAddresses |
string[] | Reply-to addresses for the email. |
options.email.ccAddresses |
string[] | CC recipients. |
options.email.bccAddresses |
string[] | BCC recipients. |
options.email.fromAddress |
string | Override sender email address. |
options.email.fromName |
string | Override sender display name. |
options.email.openTracking |
boolean | When false, this send does not record opens and no open pixel is added. Delivery, bounce, and complaint events are unchanged. Defaults to true. |
options.email.clickTracking |
boolean | When false, links are left as written and clicks are not recorded. Delivery, bounce, and complaint events are unchanged. Defaults to true. |
options.email.attachments |
(object | object)[] | File attachments (by URL or inline base64 content). Inline content: ~4 MB raw per file (413 if exceeded). URL url: up to 20 MB per file. |
options.apn |
object | Apple Push Notification (APN) overrides. |
options.apn.expiry |
number | Seconds until the notification expires. |
options.apn.priority |
number | Delivery priority (10 = immediate, 5 = power-saving). |
options.apn.collapseId |
string | Group notifications with the same ID (replaces previous). |
options.apn.threadId |
string | Thread identifier for grouping notifications. |
options.apn.badge |
number | Badge count on app icon. |
options.apn.sound |
string | Sound file name. |
options.apn.contentAvailable |
boolean | Silent background notification (no alert). |
options.fcm |
object | Firebase Cloud Messaging (FCM) overrides. |
options.fcm.android |
object | Android-specific FCM options. |
options.fcm.android.collapseKey |
string | Collapse key for grouping messages. |
options.fcm.android.priority |
“high” | “normal” | Delivery priority. |
options.fcm.android.ttl |
number | Time to live in seconds. |
options.fcm.android.restrictedPackageName |
string | Restrict delivery to a specific package. |
options.push |
object | Cross-platform mobile push options (applied to both APN and FCM). |
options.push.customData |
Record<string, string> | Up to 3 custom string key-value pairs for deep linking. Included in both APN and FCM payloads. |
schedule |
string | |
email |
object | Inline email content (subject, html). Use when not using templates. |
email.subject |
string | (required) Email subject line. |
email.html |
string | (required) HTML body content. |
email.previewText |
string | Preview/snippet text shown in inbox. |
email.senderName |
string | Display name of sender. |
email.senderEmail |
string | Sender email address. |
inapp |
object | Inline in-app content (title, url, image). |
inapp.title |
string | (required) Notification title. |
inapp.url |
string | URL to open when clicked. |
inapp.image |
string | Image URL. |
sms |
object | Inline SMS content (message, from, mediaUrls). |
sms.message |
string | SMS/MMS body text. |
sms.mediaUrls |
string[] | Public HTTPS URLs of media to attach (MMS). Carriers fetch these via GET. Total size limits apply per provider. |
sms.from |
string | Override the sender phone number. Must be a verified number on your account. |
call |
object | Inline call content (message). |
call.message |
string | (required) Text to speak (TTS). |
web_push |
object | Inline web push content (title, message, icon, url). |
web_push.title |
string | (required) Notification title. |
web_push.message |
string | (required) Body text. |
web_push.icon |
string | Icon URL. |
web_push.url |
string | URL to open when clicked. |
mobile_push |
object | Inline mobile push content (title, message). |
mobile_push.title |
string | (required) Notification title. |
mobile_push.message |
string | (required) Body text. |
slack |
object | Inline Slack content (text, blocks, etc.). |
slack.text |
string | (required) Fallback plain text (required when using blocks). |
slack.blocks |
Record<string, any>[] | Slack Block Kit blocks. |
slack.username |
string | Override bot username. |
slack.icon |
string | Icon: emoji (e.g. “:smile:”) or URL. Default: bot’s icon. |
slack.thread_ts |
string | Parent message ts to post in a thread. |
slack.reply_broadcast |
boolean | When true with thread_ts, broadcasts reply to channel. Default: false. |
slack.parse |
“full” | “none” | URL parsing: “full” (clickable links) or “none”. Default: “none”. |
slack.link_names |
boolean | Convert channel and username refs to Slack links. Default: false. |
slack.mrkdwn |
boolean | Enable Slack markup (bold, italic, code). Default: true. |
slack.unfurl_links |
boolean | Unfurl link previews. Default: true. |
slack.unfurl_media |
boolean | Unfurl media previews. Default: true. |
slack.metadata |
object | Slack message metadata with optional work object entities. Combines standard Slack message metadata fields with an array of entity objects. |
slack.metadata.entities |
object[] | An array of work object entities. |
slack.metadata.entities[].entity_type |
string | (required) Entity type (e.g., ‘slack#/entities/task’, ‘slack#/entities/file’). |
slack.metadata.entities[].entity_payload |
Record<string, any> | (required) Schema for the given entity type. |
slack.metadata.entities[].external_ref |
object | (required) Reference used to identify an entity within the developer’s system. |
slack.metadata.entities[].external_ref.id |
string | (required) |
slack.metadata.entities[].external_ref.type |
string | |
slack.metadata.entities[].url |
string | (required) URL used to identify an entity within the developer’s system. |
slack.metadata.entities[].app_unfurl_url |
string | The exact URL posted in the source message. Required in metadata passed to chat.unfurl. |
slack.metadata.event_type |
string | A human readable alphanumeric string representing your application’s metadata event. |
slack.metadata.event_payload |
Record<string, any> | A free-form object containing whatever data your application wishes to attach to messages. |
Sms
SmsSend()
Send an SMS or MMS directly without a template
sendSmsRequest := *pingram.NewSendSmsRequest("Type_example", "To_example") // SendSmsRequest
resp, _, err := client.SmsAPI.SmsSend(ctx).SendSmsRequest(sendSmsRequest).Execute()if err != nil { // handle error}// resp is SendSmsResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
type |
string | (required) The notification type to send. |
to |
string | (required) The phone number of the recipient. |
message |
string | The message of the SMS or MMS notification. Optional when mediaUrls is provided. |
mediaUrls |
string[] | Public HTTPS URLs of media to attach (MMS). |
schedule |
string | The ISO 8601 datetime to schedule the SMS notification. |
from |
string | Override the sender phone number. Must be a dedicated number on your Pingram account. |
SubNotifications
SubNotificationsDeleteSubNotification()
This endpoint is no longer maintained and should not be used
notificationId := // The notification IDsubNotificationId := // The sub-notification ID
_, err := client.SubNotificationsAPI.SubNotificationsDeleteSubNotification(ctx, notificationId, subNotificationId).Execute()if err != nil { // handle error}Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | The notification ID | |
| subNotificationId | string | The sub-notification ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
SubNotificationsPutSubNotification()
This endpoint is no longer maintained and should not be used
notificationId := // The notification IDsubNotificationId := // The sub-notification IDsubNotificationPUTRequest := *pingram.NewSubNotificationPUTRequest("Title_example") // SubNotificationPUTRequest
resp, _, err := client.SubNotificationsAPI.SubNotificationsPutSubNotification(ctx, notificationId, subNotificationId).SubNotificationPUTRequest(subNotificationPUTRequest).Execute()if err != nil { // handle error}// resp is SubNotificationParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | The notification ID | |
| subNotificationId | string | The sub-notification ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
title |
string | (required) |
Templates
TemplatesCreateTemplate()
Create a new template for a notification
notificationId := // Notification IDchannel := // Channel typetemplatePostRequest := *pingram.NewTemplatePostRequest("TemplateId_example") // TemplatePostRequest
resp, _, err := client.TemplatesAPI.TemplatesCreateTemplate(ctx, notificationId, channel).TemplatePostRequest(templatePostRequest).Execute()if err != nil { // handle error}// resp is TemplateParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | Notification ID | |
| channel | string | Channel type | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
templateId |
string | (required) Unique ID for this template within the notification and channel. Required. |
html |
string | HTML body of the email. |
previewText |
string | Preview text (e.g. for inbox). |
internal |
string | Internal editor representation of the email content (e.g. Bee or Redactor JSON). Used for editing and component embedding; the actual email sent to recipients uses the html field. |
subject |
string | Email subject line. |
senderName |
string | Sender display name. |
senderEmail |
string | Sender email address. |
title |
string | Notification title (in-app). |
redirectURL |
string | URL to open when the user taps the notification. |
imageURL |
string | Image URL shown in the in-app notification. |
instant |
object | Copy for instant (real-time) delivery. |
instant.title |
string | |
instant.redirectURL |
string | |
instant.imageURL |
string | (required) |
batch |
object | Copy for batch delivery. |
batch.title |
string | (required) |
batch.redirectURL |
string | (required) |
batch.imageURL |
string | (required) |
text |
string | Message text (SMS or call). |
message |
string | Push notification body text. (title is shared with INAPP_WEB above.) |
icon |
string | Web push: icon URL. Slack: bot icon (emoji or URL). |
url |
string | Web push: URL to open when the notification is clicked. |
blocks |
Record<string, any>[] | Slack message blocks (optional). |
username |
string | Slack bot username. |
TemplatesDeleteTemplate()
Delete a template
notificationId := // Notification IDchannel := // Channel typetemplateId := // Template ID
_, err := client.TemplatesAPI.TemplatesDeleteTemplate(ctx, notificationId, channel, templateId).Execute()if err != nil { // handle error}Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | Notification ID | |
| channel | string | Channel type | |
| templateId | string | Template ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
TemplatesGetTemplate()
Get a single template by ID
notificationId := // Notification IDchannel := // Channel typetemplateId := // Template ID
resp, _, err := client.TemplatesAPI.TemplatesGetTemplate(ctx, notificationId, channel, templateId).Execute()if err != nil { // handle error}// resp is GetTemplatesResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | Notification ID | |
| channel | string | Channel type | |
| templateId | string | Template ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
TemplatesListTemplates()
List all templates for a notification and channel
notificationId := // Notification IDchannel := // Channel type
resp, _, err := client.TemplatesAPI.TemplatesListTemplates(ctx, notificationId, channel).Execute()if err != nil { // handle error}// resp is []GetTemplatesListResponseInnerParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | Notification ID | |
| channel | string | Channel type | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
TemplatesSetDefaultTemplate()
Set a template as default for specific delivery modes
notificationId := // Notification IDchannel := // Channel typesetDefaultTemplateRequest := *pingram.NewSetDefaultTemplateRequest("TemplateId_example", []string{"Modes_example"}) // SetDefaultTemplateRequest
resp, _, err := client.TemplatesAPI.TemplatesSetDefaultTemplate(ctx, notificationId, channel).SetDefaultTemplateRequest(setDefaultTemplateRequest).Execute()if err != nil { // handle error}// resp is TemplateParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | Notification ID | |
| channel | string | Channel type | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
templateId |
string | (required) |
modes |
(“instant” | “hourly” | “daily” | “weekly” | “monthly”)[] | (required) |
TemplatesUpdateTemplate()
Update a template’s properties
notificationId := // Notification IDchannel := // Channel typetemplateId := // Template IDtemplatePatchRequest := *pingram.NewTemplatePatchRequest() // TemplatePatchRequest
resp, _, err := client.TemplatesAPI.TemplatesUpdateTemplate(ctx, notificationId, channel, templateId).TemplatePatchRequest(templatePatchRequest).Execute()if err != nil { // handle error}// resp is TemplateParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | Notification ID | |
| channel | string | Channel type | |
| templateId | string | Template ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
html |
string | HTML body of the email. |
previewText |
string | Preview text (e.g. for inbox). |
internal |
string | Internal editor representation of the email content (e.g. Bee or Redactor JSON). Used for editing and component embedding; the actual email sent to recipients uses the html field. |
subject |
string | Email subject line. |
senderName |
string | Sender display name. |
senderEmail |
string | Sender email address. |
title |
string | Notification title (in-app). |
redirectURL |
string | URL to open when the user taps the notification. |
imageURL |
string | Image URL shown in the in-app notification. |
instant |
object | Copy for instant (real-time) delivery. |
instant.title |
string | |
instant.redirectURL |
string | |
instant.imageURL |
string | (required) |
batch |
object | Copy for batch delivery. |
batch.title |
string | (required) |
batch.redirectURL |
string | (required) |
batch.imageURL |
string | (required) |
text |
string | Message text (SMS or call). |
message |
string | Push notification body text. (title is shared with INAPP_WEB above.) |
icon |
string | Web push: icon URL. Slack: bot icon (emoji or URL). |
url |
string | Web push: URL to open when the notification is clicked. |
blocks |
Record<string, any>[] | Slack message blocks (optional). |
username |
string | Slack bot username. |
Types
TypesCreateNotificationType()
Create a new notification
notificationCreateRequest := *pingram.NewNotificationCreateRequest("NotificationId_example", "Title_example", []string{"Channels_example"}) // NotificationCreateRequest
resp, _, err := client.TypesAPI.TypesCreateNotificationType(ctx).NotificationCreateRequest(notificationCreateRequest).Execute()if err != nil { // handle error}// resp is NotificationParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
notificationId |
string | (required) |
title |
string | (required) |
channels |
string[] | (required) |
options |
object | |
options.EMAIL |
object | |
options.EMAIL.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.EMAIL.off |
object | |
options.EMAIL.off.enabled |
boolean | (required) |
options.EMAIL.instant |
object | |
options.EMAIL.instant.enabled |
boolean | (required) |
options.EMAIL.hourly |
object | |
options.EMAIL.hourly.enabled |
boolean | (required) |
options.EMAIL.daily |
object | |
options.EMAIL.daily.enabled |
boolean | (required) |
options.EMAIL.daily.hour |
string | |
options.EMAIL.weekly |
object | |
options.EMAIL.weekly.enabled |
boolean | (required) |
options.EMAIL.weekly.hour |
string | |
options.EMAIL.weekly.day |
string | |
options.EMAIL.monthly |
object | |
options.EMAIL.monthly.enabled |
boolean | (required) |
options.EMAIL.monthly.hour |
string | |
options.EMAIL.monthly.date |
“first” | “last” | |
options.INAPP_WEB |
object | |
options.INAPP_WEB.defaultDeliveryOption |
“off” | “instant” | (required) |
options.INAPP_WEB.off |
object | |
options.INAPP_WEB.off.enabled |
boolean | (required) |
options.INAPP_WEB.instant |
object | |
options.INAPP_WEB.instant.enabled |
boolean | (required) |
options.INAPP_WEB.instant.batching |
boolean | |
options.INAPP_WEB.instant.batchingKey |
string | |
options.INAPP_WEB.instant.batchingWindow |
number | |
options.SMS |
object | |
options.SMS.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.SMS.off |
object | |
options.SMS.off.enabled |
boolean | (required) |
options.SMS.instant |
object | |
options.SMS.instant.enabled |
boolean | (required) |
options.SMS.hourly |
object | |
options.SMS.hourly.enabled |
boolean | (required) |
options.SMS.daily |
object | |
options.SMS.daily.enabled |
boolean | (required) |
options.SMS.daily.hour |
string | |
options.SMS.weekly |
object | |
options.SMS.weekly.enabled |
boolean | (required) |
options.SMS.weekly.hour |
string | |
options.SMS.weekly.day |
string | |
options.SMS.monthly |
object | |
options.SMS.monthly.enabled |
boolean | (required) |
options.SMS.monthly.hour |
string | |
options.SMS.monthly.date |
“first” | “last” | |
options.CALL |
object | |
options.CALL.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.CALL.off |
object | |
options.CALL.off.enabled |
boolean | (required) |
options.CALL.instant |
object | |
options.CALL.instant.enabled |
boolean | (required) |
options.CALL.hourly |
object | |
options.CALL.hourly.enabled |
boolean | (required) |
options.CALL.daily |
object | |
options.CALL.daily.enabled |
boolean | (required) |
options.CALL.daily.hour |
string | |
options.CALL.weekly |
object | |
options.CALL.weekly.enabled |
boolean | (required) |
options.CALL.weekly.hour |
string | |
options.CALL.weekly.day |
string | |
options.CALL.monthly |
object | |
options.CALL.monthly.enabled |
boolean | (required) |
options.CALL.monthly.hour |
string | |
options.CALL.monthly.date |
“first” | “last” | |
options.VOICE |
object | |
options.VOICE.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.VOICE.off |
object | |
options.VOICE.off.enabled |
boolean | (required) |
options.VOICE.instant |
object | |
options.VOICE.instant.enabled |
boolean | (required) |
options.VOICE.hourly |
object | |
options.VOICE.hourly.enabled |
boolean | (required) |
options.VOICE.daily |
object | |
options.VOICE.daily.enabled |
boolean | (required) |
options.VOICE.daily.hour |
string | |
options.VOICE.weekly |
object | |
options.VOICE.weekly.enabled |
boolean | (required) |
options.VOICE.weekly.hour |
string | |
options.VOICE.weekly.day |
string | |
options.VOICE.monthly |
object | |
options.VOICE.monthly.enabled |
boolean | (required) |
options.VOICE.monthly.hour |
string | |
options.VOICE.monthly.date |
“first” | “last” | |
options.PUSH |
object | |
options.PUSH.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.PUSH.off |
object | |
options.PUSH.off.enabled |
boolean | (required) |
options.PUSH.instant |
object | |
options.PUSH.instant.enabled |
boolean | (required) |
options.PUSH.hourly |
object | |
options.PUSH.hourly.enabled |
boolean | (required) |
options.PUSH.daily |
object | |
options.PUSH.daily.enabled |
boolean | (required) |
options.PUSH.daily.hour |
string | |
options.PUSH.weekly |
object | |
options.PUSH.weekly.enabled |
boolean | (required) |
options.PUSH.weekly.hour |
string | |
options.PUSH.weekly.day |
string | |
options.PUSH.monthly |
object | |
options.PUSH.monthly.enabled |
boolean | (required) |
options.PUSH.monthly.hour |
string | |
options.PUSH.monthly.date |
“first” | “last” | |
options.WEB_PUSH |
object | |
options.WEB_PUSH.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.WEB_PUSH.off |
object | |
options.WEB_PUSH.off.enabled |
boolean | (required) |
options.WEB_PUSH.instant |
object | |
options.WEB_PUSH.instant.enabled |
boolean | (required) |
options.WEB_PUSH.hourly |
object | |
options.WEB_PUSH.hourly.enabled |
boolean | (required) |
options.WEB_PUSH.daily |
object | |
options.WEB_PUSH.daily.enabled |
boolean | (required) |
options.WEB_PUSH.daily.hour |
string | |
options.WEB_PUSH.weekly |
object | |
options.WEB_PUSH.weekly.enabled |
boolean | (required) |
options.WEB_PUSH.weekly.hour |
string | |
options.WEB_PUSH.weekly.day |
string | |
options.WEB_PUSH.monthly |
object | |
options.WEB_PUSH.monthly.enabled |
boolean | (required) |
options.WEB_PUSH.monthly.hour |
string | |
options.WEB_PUSH.monthly.date |
“first” | “last” | |
options.SLACK |
object | |
options.SLACK.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.SLACK.off |
object | |
options.SLACK.off.enabled |
boolean | (required) |
options.SLACK.instant |
object | |
options.SLACK.instant.enabled |
boolean | (required) |
options.SLACK.hourly |
object | |
options.SLACK.hourly.enabled |
boolean | (required) |
options.SLACK.daily |
object | |
options.SLACK.daily.enabled |
boolean | (required) |
options.SLACK.daily.hour |
string | |
options.SLACK.weekly |
object | |
options.SLACK.weekly.enabled |
boolean | (required) |
options.SLACK.weekly.hour |
string | |
options.SLACK.weekly.day |
string | |
options.SLACK.monthly |
object | |
options.SLACK.monthly.enabled |
boolean | (required) |
options.SLACK.monthly.hour |
string | |
options.SLACK.monthly.date |
“first” | “last” |
TypesDeleteNotificationType()
Delete a notification
notificationId := // The notification ID
_, err := client.TypesAPI.TypesDeleteNotificationType(ctx, notificationId).Execute()if err != nil { // handle error}Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | The notification ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
TypesGetNotificationType()
Get a specific notification by ID
notificationId := // The notification ID
resp, _, err := client.TypesAPI.TypesGetNotificationType(ctx, notificationId).Execute()if err != nil { // handle error}// resp is []GetNotificationsResponseInnerParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | The notification ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
TypesListNotificationTypes()
Get all notifications for an account with their templates
resp, _, err := client.TypesAPI.TypesListNotificationTypes(ctx).Execute()if err != nil { // handle error}// resp is []GetNotificationsResponseInnerParameters
This endpoint does not need any parameter.
TypesUpdateNotificationType()
Update a notification’s settings
notificationId := // The notification IDnotificationPatchRequest := *pingram.NewNotificationPatchRequest() // NotificationPatchRequest
resp, _, err := client.TypesAPI.TypesUpdateNotificationType(ctx, notificationId).NotificationPatchRequest(notificationPatchRequest).Execute()if err != nil { // handle error}// resp is NotificationParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| notificationId | string | The notification ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
title |
string | |
channels |
(“EMAIL” | “INAPP_WEB” | “SMS” | “CALL” | “VOICE” | “PUSH” | “WEB_PUSH” | “SLACK”)[] | |
enabled |
boolean | |
deduplication |
object | |
deduplication.duration |
number | (required) |
throttling |
object | |
throttling.max |
number | (required) |
throttling.period |
number | (required) |
throttling.unit |
“seconds” | “minutes” | “hours” | “days” | “months” | “years” | (required) |
throttling.forever |
boolean | (required) |
throttling.scope |
(“userId” | “notificationId”)[] | (required) |
retention |
number | null |
options |
object | |
options.EMAIL |
object | |
options.EMAIL.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.EMAIL.off |
object | |
options.EMAIL.off.enabled |
boolean | (required) |
options.EMAIL.instant |
object | |
options.EMAIL.instant.enabled |
boolean | (required) |
options.EMAIL.hourly |
object | |
options.EMAIL.hourly.enabled |
boolean | (required) |
options.EMAIL.daily |
object | |
options.EMAIL.daily.enabled |
boolean | (required) |
options.EMAIL.daily.hour |
string | |
options.EMAIL.weekly |
object | |
options.EMAIL.weekly.enabled |
boolean | (required) |
options.EMAIL.weekly.hour |
string | |
options.EMAIL.weekly.day |
string | |
options.EMAIL.monthly |
object | |
options.EMAIL.monthly.enabled |
boolean | (required) |
options.EMAIL.monthly.hour |
string | |
options.EMAIL.monthly.date |
“first” | “last” | |
options.INAPP_WEB |
object | |
options.INAPP_WEB.defaultDeliveryOption |
“off” | “instant” | (required) |
options.INAPP_WEB.off |
object | |
options.INAPP_WEB.off.enabled |
boolean | (required) |
options.INAPP_WEB.instant |
object | |
options.INAPP_WEB.instant.enabled |
boolean | (required) |
options.INAPP_WEB.instant.batching |
boolean | |
options.INAPP_WEB.instant.batchingKey |
string | |
options.INAPP_WEB.instant.batchingWindow |
number | |
options.SMS |
object | |
options.SMS.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.SMS.off |
object | |
options.SMS.off.enabled |
boolean | (required) |
options.SMS.instant |
object | |
options.SMS.instant.enabled |
boolean | (required) |
options.SMS.hourly |
object | |
options.SMS.hourly.enabled |
boolean | (required) |
options.SMS.daily |
object | |
options.SMS.daily.enabled |
boolean | (required) |
options.SMS.daily.hour |
string | |
options.SMS.weekly |
object | |
options.SMS.weekly.enabled |
boolean | (required) |
options.SMS.weekly.hour |
string | |
options.SMS.weekly.day |
string | |
options.SMS.monthly |
object | |
options.SMS.monthly.enabled |
boolean | (required) |
options.SMS.monthly.hour |
string | |
options.SMS.monthly.date |
“first” | “last” | |
options.CALL |
object | |
options.CALL.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.CALL.off |
object | |
options.CALL.off.enabled |
boolean | (required) |
options.CALL.instant |
object | |
options.CALL.instant.enabled |
boolean | (required) |
options.CALL.hourly |
object | |
options.CALL.hourly.enabled |
boolean | (required) |
options.CALL.daily |
object | |
options.CALL.daily.enabled |
boolean | (required) |
options.CALL.daily.hour |
string | |
options.CALL.weekly |
object | |
options.CALL.weekly.enabled |
boolean | (required) |
options.CALL.weekly.hour |
string | |
options.CALL.weekly.day |
string | |
options.CALL.monthly |
object | |
options.CALL.monthly.enabled |
boolean | (required) |
options.CALL.monthly.hour |
string | |
options.CALL.monthly.date |
“first” | “last” | |
options.VOICE |
object | |
options.VOICE.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.VOICE.off |
object | |
options.VOICE.off.enabled |
boolean | (required) |
options.VOICE.instant |
object | |
options.VOICE.instant.enabled |
boolean | (required) |
options.VOICE.hourly |
object | |
options.VOICE.hourly.enabled |
boolean | (required) |
options.VOICE.daily |
object | |
options.VOICE.daily.enabled |
boolean | (required) |
options.VOICE.daily.hour |
string | |
options.VOICE.weekly |
object | |
options.VOICE.weekly.enabled |
boolean | (required) |
options.VOICE.weekly.hour |
string | |
options.VOICE.weekly.day |
string | |
options.VOICE.monthly |
object | |
options.VOICE.monthly.enabled |
boolean | (required) |
options.VOICE.monthly.hour |
string | |
options.VOICE.monthly.date |
“first” | “last” | |
options.PUSH |
object | |
options.PUSH.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.PUSH.off |
object | |
options.PUSH.off.enabled |
boolean | (required) |
options.PUSH.instant |
object | |
options.PUSH.instant.enabled |
boolean | (required) |
options.PUSH.hourly |
object | |
options.PUSH.hourly.enabled |
boolean | (required) |
options.PUSH.daily |
object | |
options.PUSH.daily.enabled |
boolean | (required) |
options.PUSH.daily.hour |
string | |
options.PUSH.weekly |
object | |
options.PUSH.weekly.enabled |
boolean | (required) |
options.PUSH.weekly.hour |
string | |
options.PUSH.weekly.day |
string | |
options.PUSH.monthly |
object | |
options.PUSH.monthly.enabled |
boolean | (required) |
options.PUSH.monthly.hour |
string | |
options.PUSH.monthly.date |
“first” | “last” | |
options.WEB_PUSH |
object | |
options.WEB_PUSH.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.WEB_PUSH.off |
object | |
options.WEB_PUSH.off.enabled |
boolean | (required) |
options.WEB_PUSH.instant |
object | |
options.WEB_PUSH.instant.enabled |
boolean | (required) |
options.WEB_PUSH.hourly |
object | |
options.WEB_PUSH.hourly.enabled |
boolean | (required) |
options.WEB_PUSH.daily |
object | |
options.WEB_PUSH.daily.enabled |
boolean | (required) |
options.WEB_PUSH.daily.hour |
string | |
options.WEB_PUSH.weekly |
object | |
options.WEB_PUSH.weekly.enabled |
boolean | (required) |
options.WEB_PUSH.weekly.hour |
string | |
options.WEB_PUSH.weekly.day |
string | |
options.WEB_PUSH.monthly |
object | |
options.WEB_PUSH.monthly.enabled |
boolean | (required) |
options.WEB_PUSH.monthly.hour |
string | |
options.WEB_PUSH.monthly.date |
“first” | “last” | |
options.SLACK |
object | |
options.SLACK.defaultDeliveryOption |
“off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) |
options.SLACK.off |
object | |
options.SLACK.off.enabled |
boolean | (required) |
options.SLACK.instant |
object | |
options.SLACK.instant.enabled |
boolean | (required) |
options.SLACK.hourly |
object | |
options.SLACK.hourly.enabled |
boolean | (required) |
options.SLACK.daily |
object | |
options.SLACK.daily.enabled |
boolean | (required) |
options.SLACK.daily.hour |
string | |
options.SLACK.weekly |
object | |
options.SLACK.weekly.enabled |
boolean | (required) |
options.SLACK.weekly.hour |
string | |
options.SLACK.weekly.day |
string | |
options.SLACK.monthly |
object | |
options.SLACK.monthly.enabled |
boolean | (required) |
options.SLACK.monthly.hour |
string | |
options.SLACK.monthly.date |
“first” | “last” |
Usage
AccountGetUsage()
Get usage for the authenticated account
resp, _, err := client.AccountAPI.AccountGetUsage(ctx).Execute()if err != nil { // handle error}// resp is GetUsageResponseParameters
This endpoint does not need any parameter.
AccountGetUsageHistory()
Get usage history
startDate := "startDate_example" // stringendDate := "endDate_example" // stringgroupBy := "groupBy_example" // string (optional)
resp, _, err := client.AccountAPI.AccountGetUsageHistory(ctx).StartDate(startDate).EndDate(endDate).GroupBy(groupBy).Execute()if err != nil { // handle error}// resp is GetUsageHistoryResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| startDate | string | Start date (YYYY-MM-DD) for the range | |
| endDate | string | End date (YYYY-MM-DD) for the range | |
| groupBy | string | calendar (UTC months, default) or billing (account billing cycles) |
User
UserGetAccountMetadata()
Get account metadata
resp, _, err := client.UserAPI.UserGetAccountMetadata(ctx).Execute()if err != nil { // handle error}// resp is GetAccountMetadataResponseParameters
This endpoint does not need any parameter.
UserGetUser()
Get a user by ID
userId := // User ID
resp, _, err := client.UserAPI.UserGetUser(ctx, userId).Execute()if err != nil { // handle error}// resp is UserParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| userId | string | User ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
UserIdentify()
Create or update a user with the given ID
userId := // User IDpostUserRequest := *pingram.NewPostUserRequest() // PostUserRequest
resp, _, err := client.UserAPI.UserIdentify(ctx, userId).PostUserRequest(postUserRequest).Execute()if err != nil { // handle error}// resp is UserParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| userId | string | User ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
id |
string | Unique user identifier. Required. |
email |
string | User’s email address for email notifications. |
number |
string | User’s phone number for SMS/call notifications. |
pushTokens |
object[] | Mobile push tokens (FCM, APN) for push notifications. |
pushTokens[].type |
“FCM” | “APN” | (required) |
pushTokens[].token |
string | (required) |
pushTokens[].device |
object | (required) |
pushTokens[].device.app_id |
string | |
pushTokens[].device.ad_id |
string | |
pushTokens[].device.device_id |
string | (required) |
pushTokens[].device.platform |
string | |
pushTokens[].device.manufacturer |
string | |
pushTokens[].device.model |
string | |
pushTokens[].environment |
string | used by APN to differentiate between sandbox and production builds (sandbox/undefined or production) |
webPushTokens |
object[] | Web push subscription config from the browser. |
webPushTokens[].sub |
object | (required) Configuration for a Push Subscription. This can be obtained on the frontend by calling serviceWorkerRegistration.pushManager.subscribe(). The expected format is the same output as JSON.stringify’ing a PushSubscription in the browser. |
webPushTokens[].sub.endpoint |
string | (required) |
webPushTokens[].sub.keys |
object | (required) |
webPushTokens[].sub.keys.p256dh |
string | (required) |
webPushTokens[].sub.keys.auth |
string | (required) |
timezone |
string | User’s timezone (e.g. “America/New_York”) for scheduling. |
slackChannel |
string | The destination channel of slack notifications sent to this user. Can be either of the following: - Channel name, e.g. “test” - Channel name with # prefix, e.g. “#test” - Channel ID, e.g. “C1234567890” - User ID for DM, e.g. “U1234567890” - Username with @ prefix, e.g. “@test” |
slackToken |
object | |
slackToken.access_token |
string | |
slackToken.app_id |
string | |
slackToken.authed_user |
object | |
slackToken.authed_user.access_token |
string | |
slackToken.authed_user.expires_in |
number | |
slackToken.authed_user.id |
string | |
slackToken.authed_user.refresh_token |
string | |
slackToken.authed_user.scope |
string | |
slackToken.authed_user.token_type |
string | |
slackToken.bot_user_id |
string | |
slackToken.enterprise |
object | |
slackToken.enterprise.id |
string | |
slackToken.enterprise.name |
string | |
slackToken.error |
string | |
slackToken.expires_in |
number | |
slackToken.incoming_webhook |
object | |
slackToken.incoming_webhook.channel |
string | |
slackToken.incoming_webhook.channel_id |
string | |
slackToken.incoming_webhook.configuration_url |
string | |
slackToken.incoming_webhook.url |
string | |
slackToken.is_enterprise_install |
boolean | |
slackToken.needed |
string | |
slackToken.ok |
boolean | (required) |
slackToken.provided |
string | |
slackToken.refresh_token |
string | |
slackToken.scope |
string | |
slackToken.team |
object | |
slackToken.team.id |
string | |
slackToken.team.name |
string | |
slackToken.token_type |
string | |
slackToken.warning |
string | |
slackToken.response_metadata |
object | |
slackToken.response_metadata.warnings |
string[] | |
slackToken.response_metadata.next_cursor |
string | |
slackToken.response_metadata.scopes |
string[] | |
slackToken.response_metadata.acceptedScopes |
string[] | |
slackToken.response_metadata.retryAfter |
number | |
slackToken.response_metadata.messages |
string[] | |
properties |
Record<string, string | number | boolean> | Custom key-value properties synced by the developer, used for audience segmentation (e.g. broadcast filters on user.properties.plan). Incremental identify calls shallow-merge keys (unset keys are preserved). Limits: max 25 keys, key length <= 64, string values <= 256 chars, serialized size <= 1KB. |
Users
UsersDeleteUser()
Delete a user
userId := // User IDenvId := "envId_example" // string (optional)
resp, _, err := client.UsersAPI.UsersDeleteUser(ctx, userId).EnvId(envId).Execute()if err != nil { // handle error}// resp is DeleteUserResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| userId | string | User ID | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
envId | string | Environment ID (required when using JWT auth) |
UsersListUsers()
Get all users for an environment with pagination support
limit := float32(8.14) // float32nextToken := "nextToken_example" // stringenvId := "envId_example" // string (optional)
resp, _, err := client.UsersAPI.UsersListUsers(ctx).Limit(limit).NextToken(nextToken).EnvId(envId).Execute()if err != nil { // handle error}// resp is GetUsersResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | float32 | Maximum number of users to return (default | |
| nextToken | string | Pagination token for next page | |
| envId | string | Environment ID (required when using JWT auth) |
UsersRemoveUserFromSuppression()
Remove user suppression status for a specific channel
userId := // User IDchannel := // Channel type (EMAIL)envId := "envId_example" // string (optional)
resp, _, err := client.UsersAPI.UsersRemoveUserFromSuppression(ctx, userId, channel).EnvId(envId).Execute()if err != nil { // handle error}// resp is UserSuppressionDeleteResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| userId | string | User ID | |
| channel | string | Channel type (EMAIL) | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
envId | string | Environment ID (required when using JWT auth) |
Voice
VoiceArmInboundClaim()
Arm the shared test number
armVoiceInboundClaimRequest := *pingram.NewArmVoiceInboundClaimRequest(pingram.ArmVoiceInboundClaimRequest_inbound{Agent: pingram.NewAgent("Type_example", *pingram.NewAgentAgent("Instructions_example", pingram.Agent_agent_model{ElevenlabsElevenRealtimeV1Max: pingram.NewElevenlabsElevenRealtimeV1Max("Model_example")}))}) // ArmVoiceInboundClaimRequest
resp, _, err := client.VoiceAPI.VoiceArmInboundClaim(ctx).ArmVoiceInboundClaimRequest(armVoiceInboundClaimRequest).Execute()if err != nil { // handle error}// resp is ArmVoiceInboundClaimResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
inbound |
object | object | object | object | object | object | (required) |
inbound.type |
“script” | (required) |
inbound.steps |
object[] | (required) |
inbound.steps[].verb |
“Say” | (required) |
inbound.steps[].text |
string | (required) |
inbound.stream |
object | What the call socket carries. Omitted means the socket is open and carries neither. |
inbound.stream.audio |
boolean | Live call audio. Omitted means off. |
inbound.stream.transcript |
“single” | “multichannel” | single mixes every channel into one stream. multichannel transcribes each channel. Omitted means off. |
inbound.privacy |
object | Omitted record and transcript mean both are off. |
inbound.privacy.record |
boolean | |
inbound.privacy.transcript |
“single” | “multichannel” | single mixes every channel into one stream. multichannel transcribes each channel. Omitted means off. |
VoiceCall()
Place an outbound call. The config is not saved
voiceCallRequest := *pingram.NewVoiceCallRequest("To_example", pingram.VoiceBrowserCallRequest_config_anyOf{Agent1: pingram.NewAgent1("Type_example", *pingram.NewAgentAgent("Instructions_example", pingram.Agent_agent_model{ElevenlabsElevenRealtimeV1Max: pingram.NewElevenlabsElevenRealtimeV1Max("Model_example")}))}) // VoiceCallRequest
resp, _, err := client.VoiceAPI.VoiceCall(ctx).VoiceCallRequest(voiceCallRequest).Execute()if err != nil { // handle error}// resp is VoiceCallResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
to |
string | (required) E.164 number to dial. |
config |
object | object | object | object | (required) |
config.type |
“script” | (required) |
config.steps |
object[] | (required) |
config.steps[].verb |
“Say” | (required) |
config.steps[].text |
string | (required) |
config.voicemailAction |
“hangup” | “message” | “continue” | What to do when an answering machine picks up. hangup ends the call, message plays voicemailMessage, continue keeps talking. Default: continue. |
config.voicemailMessage |
string | |
config.stream |
object | What the call socket carries. Omitted means the socket is open and carries neither. |
config.stream.audio |
boolean | Live call audio. Omitted means off. |
config.stream.transcript |
“single” | “multichannel” | single mixes every channel into one stream. multichannel transcribes each channel. Omitted means off. |
config.privacy |
object | Omitted record and transcript mean both are off. |
config.privacy.record |
boolean | |
config.privacy.transcript |
“single” | “multichannel” | single mixes every channel into one stream. multichannel transcribes each channel. Omitted means off. |
variables |
Record<string, string> | Optional per-call {{variable}} overrides. |
VoiceClearNumberInbound()
Remove inbound call behavior from a number this account owns
phoneNumber := // E.164 phone number
resp, _, err := client.VoiceAPI.VoiceClearNumberInbound(ctx, phoneNumber).Execute()if err != nil { // handle error}// resp is MessageResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| phoneNumber | string | E.164 phone number | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
VoiceCreateBrowserCall()
Place a browser playground call
voiceBrowserCallRequest := *pingram.NewVoiceBrowserCallRequest(*pingram.NewVoiceBrowserCallRequestConfig("Type_example", []pingram.ScriptStepsInner{*pingram.NewScriptStepsInner("Verb_example", "Text_example")}, *pingram.NewAgentAgent("Instructions_example", pingram.Agent_agent_model{ElevenlabsElevenRealtimeV1Max: pingram.NewElevenlabsElevenRealtimeV1Max("Model_example")}), "To_example")) // VoiceBrowserCallRequest
resp, _, err := client.VoiceAPI.VoiceCreateBrowserCall(ctx).VoiceBrowserCallRequest(voiceBrowserCallRequest).Execute()if err != nil { // handle error}// resp is VoiceBrowserCallResponseParameters
| Name | Type | Description | Notes |
|---|
Request Body Properties
| Name | Type | Description |
|---|---|---|
config |
object | object | object | object | object | object | object | object | object | object | (required) Agent behavior for this browser call. Script calls use POST /voice/call. |
variables |
Record<string, string> | Optional per-call {{variable}} overrides for browser playground. |
direction |
“inbound” | “outbound” | inbound speaks the greeting. outbound speaks the opener. Omitted means outbound. |
VoiceGetCall()
Get a call recording and transcript
trackingId := // Call tracking id
resp, _, err := client.VoiceAPI.VoiceGetCall(ctx, trackingId).Execute()if err != nil { // handle error}// resp is GetVoiceCallResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| trackingId | string | Call tracking id | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
VoiceListCalls()
List recent calls newest-first (30-day retention)
limit := float32(8.14) // float32 (optional)cursor := "cursor_example" // string (optional)
resp, _, err := client.VoiceAPI.VoiceListCalls(ctx).Limit(limit).Cursor(cursor).Execute()if err != nil { // handle error}// resp is ListVoiceCallsResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | float32 | Page size (default 25, max 100) | |
| cursor | string | Pagination cursor from a previous response |
VoicePutNumberInbound()
Store inbound call behavior on a number this account owns
phoneNumber := // E.164 phone numberinboundConfig := pingram.InboundConfig{Agent: pingram.NewAgent("Type_example", *pingram.NewAgentAgent("Instructions_example", pingram.Agent_agent_model{ElevenlabsElevenRealtimeV1Max: pingram.NewElevenlabsElevenRealtimeV1Max("Model_example")}))} // InboundConfig
resp, _, err := client.VoiceAPI.VoicePutNumberInbound(ctx, phoneNumber).InboundConfig(inboundConfig).Execute()if err != nil { // handle error}// resp is MessageResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| phoneNumber | string | E.164 phone number | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
VoiceTransfer()
Move a live phone call to another number
trackingId := // Call tracking idtransferCallRequest := *pingram.NewTransferCallRequest("To_example") // TransferCallRequest
resp, _, err := client.VoiceAPI.VoiceTransfer(ctx, trackingId).TransferCallRequest(transferCallRequest).Execute()if err != nil { // handle error}// resp is MessageResponseParameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| trackingId | string | Call tracking id | |
| Name | Type | Description | Notes |
| ———–– | ———–– | ———–– | ———–– |
Request Body Properties
| Name | Type | Description |
|---|---|---|
to |
string | (required) E.164 number to move the caller to. |
holdSay |
string | Spoken once to the caller while they wait. If holdAudio is also set, this sentence plays first and then the audio. |
holdAudio |
string | builtin:soft-piano, builtin:calm, builtin:bright, or an HTTPS MP3 or WAV. Loops until the call connects. Omit it and the caller hears ringing. |
receiverSay |
string | Spoken to the person who answers, before the caller is connected. |