Go SDK

Setup & Initialization

1. Install Package:

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

2. Import:

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

3. Initialize:

client := pingram.NewClient("pingram_sk_your_api_key")

* required

Region example:

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

Working example

Full runnable example that sends a notification:

package main

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

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

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

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

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

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

Send

Send()

Send a notification

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

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

Parameters

Request Body Properties

Addresses

AddressesCreateAddress()

Create a new email address for inbound/outbound purposes. Each account can have one builtin address and many custom addresses. Custom addresses must belong to configured domains.

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

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

Parameters

Request Body Properties

AddressesListAddresses()

Lists all email addresses the account has configured to send and receive emails. Custom addresses must belong to configured domains.

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

Parameters

This endpoint does not need any parameter.

AddressesUpdateAddress()

Update an existing address

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

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

Parameters

Request Body Properties

Domains

DomainsAddDomain()

Request to verify a new sender domain

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

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

Parameters

Request Body Properties

DomainsDeleteDomain()

Delete a sender domain or email address

sender :=  // Sender domain or email address (URL encoded)

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

Parameters

DomainsListDomains()

Get all sender domains configured for the account

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

Parameters

This endpoint does not need any parameter.

Environments

EnvironmentsCreateEnvironment()

Create a new environment for the account

environmentCreateRequest := *pingram.NewEnvironmentCreateRequest("Title_example") // EnvironmentCreateRequest

resp, _, err := client.EnvironmentsAPI.EnvironmentsCreateEnvironment(ctx).EnvironmentCreateRequest(environmentCreateRequest).Execute()
if err != nil {
	// handle error
}
// resp is Environment

Parameters

Request Body Properties

EnvironmentsListEnvironments()

Get all environments for the authenticated account

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

Parameters

This endpoint does not need any parameter.

EnvironmentsUpdateEnvironment()

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

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

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

Parameters

Request Body Properties

Logs

LogsGetLogRetention()

Get log retention period in days for the account

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

Parameters

This endpoint does not need any parameter.

LogsGetLogs()

List logs for the authenticated account

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

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

Parameters

LogsGetLogsByTrackingIds()

Get logs by tracking IDs (comma-separated, max 25 IDs)

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

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

Parameters

LogsGetLogsQueryResult()

Get results from a query ID

queryId :=  // Query ID

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

Parameters

LogsStartLogsQuery()

Start a log query and return query ID for asynchronous log searching

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

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

Parameters

Request Body Properties

LogsTailLogs()

Get last 100 logs from the stream

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

Parameters

This endpoint does not need any parameter.

Organization

OrganizationGetUsage()

Get usage for the authenticated account’s organization (new billing model).

resp, _, err := client.OrganizationAPI.OrganizationGetUsage(ctx).Execute()
if err != nil {
	// handle error
}
// resp is OrganizationUsage

Parameters

This endpoint does not need any parameter.

OrganizationGetUsageHistory()

Get historical usage for the authenticated account’s organization over a date range.

startDate := "startDate_example" // string
endDate := "endDate_example" // string

resp, _, err := client.OrganizationAPI.OrganizationGetUsageHistory(ctx).StartDate(startDate).EndDate(endDate).Execute()
if err != nil {
	// handle error
}
// resp is OrganizationUsageHistory

Parameters

PushSettings

PushSettingsDeletePushApnSettings()

Delete Apple Push Notification (APN) configuration for the current account.

_, err := client.PushSettingsAPI.PushSettingsDeletePushApnSettings(ctx).Execute()
if err != nil {
	// handle error
}

Parameters

This endpoint does not need any parameter.

PushSettingsDeletePushFcmSettings()

Delete Firebase Cloud Messaging (FCM) configuration for the current account.

_, err := client.PushSettingsAPI.PushSettingsDeletePushFcmSettings(ctx).Execute()
if err != nil {
	// handle error
}

Parameters

This endpoint does not need any parameter.

PushSettingsGetPushApnSettings()

Get Apple Push Notification (APN) configuration for the current account.

resp, _, err := client.PushSettingsAPI.PushSettingsGetPushApnSettings(ctx).Execute()
if err != nil {
	// handle error
}
// resp is APNConfig

Parameters

This endpoint does not need any parameter.

PushSettingsGetPushFcmSettings()

Get Firebase Cloud Messaging (FCM) configuration for the current account.

resp, _, err := client.PushSettingsAPI.PushSettingsGetPushFcmSettings(ctx).Execute()
if err != nil {
	// handle error
}
// resp is PushSettingsFCMResponse

Parameters

This endpoint does not need any parameter.

PushSettingsUpsertPushApnSettings()

Create or update Apple Push Notification (APN) configuration for the current account.

aPNConfig := *pingram.NewAPNConfig("KeyId_example", "Key_example", "TeamId_example", "Topic_example") // APNConfig

resp, _, err := client.PushSettingsAPI.PushSettingsUpsertPushApnSettings(ctx).APNConfig(aPNConfig).Execute()
if err != nil {
	// handle error
}
// resp is APNConfig

Parameters

Request Body Properties

PushSettingsUpsertPushFcmSettings()

Create or update Firebase Cloud Messaging (FCM) configuration for the current account.

pushSettingsFCMPutRequest := *pingram.NewPushSettingsFCMPutRequest("FcmConfig_example") // PushSettingsFCMPutRequest

resp, _, err := client.PushSettingsAPI.PushSettingsUpsertPushFcmSettings(ctx).PushSettingsFCMPutRequest(pushSettingsFCMPutRequest).Execute()
if err != nil {
	// handle error
}
// resp is PushSettingsFCMResponse

Parameters

Request Body Properties

Sender

SenderDeleteSchedule()

Delete (unschedule) an already scheduled notification

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

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

Parameters

SenderUpdateSchedule()

Update the body or schedule of an already scheduled notification.

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

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

Parameters

Request Body Properties

Templates

TemplatesCreateTemplate()

Create a new template for a notification

notificationId :=  // Notification ID
channel :=  // Channel type
templatePostRequest := *pingram.NewTemplatePostRequest("TemplateId_example") // TemplatePostRequest

resp, _, err := client.TemplatesAPI.TemplatesCreateTemplate(ctx, notificationId, channel).TemplatePostRequest(templatePostRequest).Execute()
if err != nil {
	// handle error
}
// resp is Template

Parameters

Request Body Properties

TemplatesDeleteTemplate()

Delete a template

notificationId :=  // Notification ID
channel :=  // Channel type
templateId :=  // Template ID

_, err := client.TemplatesAPI.TemplatesDeleteTemplate(ctx, notificationId, channel, templateId).Execute()
if err != nil {
	// handle error
}

Parameters

TemplatesGetTemplate()

Get a single template by ID

notificationId :=  // Notification ID
channel :=  // Channel type
templateId :=  // Template ID

resp, _, err := client.TemplatesAPI.TemplatesGetTemplate(ctx, notificationId, channel, templateId).Execute()
if err != nil {
	// handle error
}
// resp is GetTemplatesResponse

Parameters

TemplatesListTemplates()

List all templates for a notification and channel

notificationId :=  // Notification ID
channel :=  // Channel type

resp, _, err := client.TemplatesAPI.TemplatesListTemplates(ctx, notificationId, channel).Execute()
if err != nil {
	// handle error
}
// resp is []GetTemplatesListResponseInner

Parameters

TemplatesSetDefaultTemplate()

Set a template as default for specific delivery modes

notificationId :=  // Notification ID
channel :=  // Channel type
setDefaultTemplateRequest := *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 Template

Parameters

Request Body Properties

TemplatesUpdateTemplate()

Update a template’s properties

notificationId :=  // Notification ID
channel :=  // Channel type
templateId :=  // Template ID
templatePatchRequest := *pingram.NewTemplatePatchRequest() // TemplatePatchRequest

resp, _, err := client.TemplatesAPI.TemplatesUpdateTemplate(ctx, notificationId, channel, templateId).TemplatePatchRequest(templatePatchRequest).Execute()
if err != nil {
	// handle error
}
// resp is Template

Parameters

Request Body Properties

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 Notification

Parameters

Request Body Properties

TypesDeleteNotificationType()

Delete a notification

notificationId :=  // The notification ID

_, err := client.TypesAPI.TypesDeleteNotificationType(ctx, notificationId).Execute()
if err != nil {
	// handle error
}

Parameters

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 []GetNotificationsResponseInner

Parameters

TypesListNotificationTypes()

Get all notifications for an account with their templates

resp, _, err := client.TypesAPI.TypesListNotificationTypes(ctx).Execute()
if err != nil {
	// handle error
}
// resp is []GetNotificationsResponseInner

Parameters

This endpoint does not need any parameter.

TypesUpdateNotificationType()

Update a notification’s settings

notificationId :=  // The notification ID
notificationPatchRequest := *pingram.NewNotificationPatchRequest() // NotificationPatchRequest

resp, _, err := client.TypesAPI.TypesUpdateNotificationType(ctx, notificationId).NotificationPatchRequest(notificationPatchRequest).Execute()
if err != nil {
	// handle error
}
// resp is Notification

Parameters

Request Body Properties

User

UserGetAccountMetadata()

Get account-level metadata including logo, VAPID key, and web push status

resp, _, err := client.UserAPI.UserGetAccountMetadata(ctx).Execute()
if err != nil {
	// handle error
}
// resp is GetAccountMetadataResponse

Parameters

This endpoint does not need any parameter.

UserGetAvailableSlackChannels()

Get list of Slack channels and users for the authenticated user

userId :=  // User ID

_, err := client.UserAPI.UserGetAvailableSlackChannels(ctx, userId).Execute()
if err != nil {
	// handle error
}

Parameters

UserGetInAppNotifications()

Get in-app notifications for a user

before := "before_example" // string (optional)
count := float32(8.14) // float32 (optional)

resp, _, err := client.UserAPI.UserGetInAppNotifications(ctx).Before(before).Count(count).Execute()
if err != nil {
	// handle error
}
// resp is GetInappNotificationsResponse

Parameters

UserGetInAppUnreadCount()

Get the count of unread in-app notifications for a user

resp, _, err := client.UserAPI.UserGetInAppUnreadCount(ctx).Execute()
if err != nil {
	// handle error
}
// resp is InappUnreadCountResponse

Parameters

This endpoint does not need any parameter.

UserGetUser()

Get a user by ID. All users exist implicitly, returns basic user object if not found in DB.

userId :=  // User ID

resp, _, err := client.UserAPI.UserGetUser(ctx, userId).Execute()
if err != nil {
	// handle error
}
// resp is User

Parameters

UserIdentify()

Create or update a user with the given ID. Updates lastSeenTime automatically.

userId :=  // User ID
postUserRequest := *pingram.NewPostUserRequest() // PostUserRequest

resp, _, err := client.UserAPI.UserIdentify(ctx, userId).PostUserRequest(postUserRequest).Execute()
if err != nil {
	// handle error
}
// resp is User

Parameters

Request Body Properties

UserMarkInAppNotificationsAsSeen()

Mark in-app web notifications as seen/read for a user

inAppNotificationUnreadClearRequest := *pingram.NewInAppNotificationUnreadClearRequest() // InAppNotificationUnreadClearRequest

resp, _, err := client.UserAPI.UserMarkInAppNotificationsAsSeen(ctx).InAppNotificationUnreadClearRequest(inAppNotificationUnreadClearRequest).Execute()
if err != nil {
	// handle error
}
// resp is SuccessResponse

Parameters

Request Body Properties

UserUpdateInAppNotificationStatus()

Update in-app web notification status (opened, archived, clicked, etc.)

inAppNotificationPatchRequest := *pingram.NewInAppNotificationPatchRequest([]string{"TrackingIds_example"}) // InAppNotificationPatchRequest

resp, _, err := client.UserAPI.UserUpdateInAppNotificationStatus(ctx).InAppNotificationPatchRequest(inAppNotificationPatchRequest).Execute()
if err != nil {
	// handle error
}
// resp is SuccessResponse

Parameters

Request Body Properties

Users

UsersDeleteUser()

Delete a user and all associated data (in-app notifications, preferences, and user record)

userId :=  // User ID
envId := "envId_example" // string (optional)

resp, _, err := client.UsersAPI.UsersDeleteUser(ctx, userId).EnvId(envId).Execute()
if err != nil {
	// handle error
}
// resp is DeleteUserResponse

Parameters

envId | string | Environment ID (required when using JWT auth) |

UsersListUsers()

Get all users for an environment with pagination support

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

resp, _, err := client.UsersAPI.UsersListUsers(ctx).Limit(limit).NextToken(nextToken).EnvId(envId).Execute()
if err != nil {
	// handle error
}
// resp is GetUsersResponse

Parameters

UsersRemoveUserFromSuppression()

Remove user suppression status for a specific channel

userId :=  // User ID
channel :=  // 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 UserSuppressionDeleteResponse

Parameters

envId | string | Environment ID (required when using JWT auth) |

Webhooks

WebhooksDeleteEventsWebhook()

Delete the events webhook configuration for the current account/environment.

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

Parameters

This endpoint does not need any parameter.

WebhooksGetEventsWebhook()

Get the events webhook configuration for the current account/environment.

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

Parameters

This endpoint does not need any parameter.

WebhooksUpsertEventsWebhook()

Create or update the events webhook configuration for the current account/environment.

eventsWebhookUpsertRequest := *pingram.NewEventsWebhookUpsertRequest("Webhook_example", []string{"Events_example"}) // EventsWebhookUpsertRequest

resp, _, err := client.WebhooksAPI.WebhooksUpsertEventsWebhook(ctx).EventsWebhookUpsertRequest(eventsWebhookUpsertRequest).Execute()
if err != nil {
	// handle error
}
// resp is EventsWebhookResponse

Parameters

Request Body Properties