C# SDK

Setup & Initialization

1. Install Package:

dotnet add package Pingram

2. Import:

using Pingram;
using Pingram.Model;

3. Initialize:

var client = new PingramClient("your_api_key");

* required

Region example:

var client = new PingramClient("your_api_key", "https://api.eu.pingram.io");

Send

Send()

Send a notification

var client = new PingramClient("your_api_key");
var senderPostBody = new ...; // see Request Body Properties below
await client.DefaultApi.SendAsync(senderPostBody);

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.

var client = new PingramClient("your_api_key");
var createAddressRequest = new ...; // see Request Body Properties below
await client.AddressesApi.AddressesCreateAddressAsync(createAddressRequest);

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.

var client = new PingramClient("your_api_key");
await client.AddressesApi.AddressesListAddressesAsync(...);

Parameters

This endpoint does not need any parameter.

AddressesUpdateAddress()

Update an existing address

var client = new PingramClient("your_api_key");
var updateAddressRequest = new ...; // see Request Body Properties below
await client.AddressesApi.AddressesUpdateAddressAsync(updateAddressRequest);

Parameters

Request Body Properties

Domains

DomainsAddDomain()

Request to verify a new sender domain

var client = new PingramClient("your_api_key");
var postSendersRequestBody = new ...; // see Request Body Properties below
await client.DomainsApi.DomainsAddDomainAsync(postSendersRequestBody);

Parameters

Request Body Properties

DomainsDeleteDomain()

Delete a sender domain or email address

var client = new PingramClient("your_api_key");
await client.DomainsApi.DomainsDeleteDomainAsync(...);

Parameters

DomainsListDomains()

Get all sender domains configured for the account

var client = new PingramClient("your_api_key");
await client.DomainsApi.DomainsListDomainsAsync(...);

Parameters

This endpoint does not need any parameter.

Environments

EnvironmentsCreateEnvironment()

Create a new environment for the account

var client = new PingramClient("your_api_key");
var environmentCreateRequest = new ...; // see Request Body Properties below
await client.EnvironmentsApi.EnvironmentsCreateEnvironmentAsync(environmentCreateRequest);

Parameters

Request Body Properties

EnvironmentsListEnvironments()

Get all environments for the authenticated account

var client = new PingramClient("your_api_key");
await client.EnvironmentsApi.EnvironmentsListEnvironmentsAsync(...);

Parameters

This endpoint does not need any parameter.

EnvironmentsUpdateEnvironment()

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

var client = new PingramClient("your_api_key");
var environmentPatchRequest = new ...; // see Request Body Properties below
await client.EnvironmentsApi.EnvironmentsUpdateEnvironmentAsync(environmentPatchRequest);

Parameters

Request Body Properties

Logs

LogsGetLogRetention()

Get log retention period in days for the account

var client = new PingramClient("your_api_key");
await client.LogsApi.LogsGetLogRetentionAsync(...);

Parameters

This endpoint does not need any parameter.

LogsGetLogs()

List logs for the authenticated account

var client = new PingramClient("your_api_key");
await client.LogsApi.LogsGetLogsAsync(...);

Parameters

LogsGetLogsByTrackingIds()

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

var client = new PingramClient("your_api_key");
await client.LogsApi.LogsGetLogsByTrackingIdsAsync(...);

Parameters

LogsGetLogsQueryResult()

Get results from a query ID

var client = new PingramClient("your_api_key");
await client.LogsApi.LogsGetLogsQueryResultAsync(...);

Parameters

LogsStartLogsQuery()

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

var client = new PingramClient("your_api_key");
var logQueryPostBody = new ...; // see Request Body Properties below
await client.LogsApi.LogsStartLogsQueryAsync(logQueryPostBody);

Parameters

Request Body Properties

LogsTailLogs()

Get last 100 logs from the stream

var client = new PingramClient("your_api_key");
await client.LogsApi.LogsTailLogsAsync(...);

Parameters

This endpoint does not need any parameter.

Organization

OrganizationGetUsage()

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

var client = new PingramClient("your_api_key");
await client.OrganizationApi.OrganizationGetUsageAsync(...);

Parameters

This endpoint does not need any parameter.

OrganizationGetUsageHistory()

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

var client = new PingramClient("your_api_key");
await client.OrganizationApi.OrganizationGetUsageHistoryAsync(...);

Parameters

PushSettings

PushSettingsDeletePushApnSettings()

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

var client = new PingramClient("your_api_key");
await client.PushSettingsApi.PushSettingsDeletePushApnSettingsAsync(...);

Parameters

This endpoint does not need any parameter.

Return Type

void (empty response body)

PushSettingsDeletePushFcmSettings()

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

var client = new PingramClient("your_api_key");
await client.PushSettingsApi.PushSettingsDeletePushFcmSettingsAsync(...);

Parameters

This endpoint does not need any parameter.

Return Type

void (empty response body)

PushSettingsGetPushApnSettings()

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

var client = new PingramClient("your_api_key");
await client.PushSettingsApi.PushSettingsGetPushApnSettingsAsync(...);

Parameters

This endpoint does not need any parameter.

PushSettingsGetPushFcmSettings()

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

var client = new PingramClient("your_api_key");
await client.PushSettingsApi.PushSettingsGetPushFcmSettingsAsync(...);

Parameters

This endpoint does not need any parameter.

PushSettingsUpsertPushApnSettings()

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

var client = new PingramClient("your_api_key");
var aPNConfig = new ...; // see Request Body Properties below
await client.PushSettingsApi.PushSettingsUpsertPushApnSettingsAsync(aPNConfig);

Parameters

Request Body Properties

PushSettingsUpsertPushFcmSettings()

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

var client = new PingramClient("your_api_key");
var pushSettingsFCMPutRequest = new ...; // see Request Body Properties below
await client.PushSettingsApi.PushSettingsUpsertPushFcmSettingsAsync(pushSettingsFCMPutRequest);

Parameters

Request Body Properties

Sender

SenderDeleteSchedule()

Delete (unschedule) an already scheduled notification

var client = new PingramClient("your_api_key");
await client.SenderApi.SenderDeleteScheduleAsync(...);

Parameters

SenderUpdateSchedule()

Update the body or schedule of an already scheduled notification.

var client = new PingramClient("your_api_key");
var senderPostBody = new ...; // see Request Body Properties below
await client.SenderApi.SenderUpdateScheduleAsync(senderPostBody);

Parameters

Request Body Properties

Templates

TemplatesCreateTemplate()

Create a new template for a notification

var client = new PingramClient("your_api_key");
var templatePostRequest = new ...; // see Request Body Properties below
await client.TemplatesApi.TemplatesCreateTemplateAsync(templatePostRequest);

Parameters

Request Body Properties

TemplatesDeleteTemplate()

Delete a template

var client = new PingramClient("your_api_key");
await client.TemplatesApi.TemplatesDeleteTemplateAsync(...);

Parameters

Return Type

void (empty response body)

TemplatesGetTemplate()

Get a single template by ID

var client = new PingramClient("your_api_key");
await client.TemplatesApi.TemplatesGetTemplateAsync(...);

Parameters

TemplatesListTemplates()

List all templates for a notification and channel

var client = new PingramClient("your_api_key");
await client.TemplatesApi.TemplatesListTemplatesAsync(...);

Parameters

TemplatesSetDefaultTemplate()

Set a template as default for specific delivery modes

var client = new PingramClient("your_api_key");
var setDefaultTemplateRequest = new ...; // see Request Body Properties below
await client.TemplatesApi.TemplatesSetDefaultTemplateAsync(setDefaultTemplateRequest);

Parameters

Request Body Properties

TemplatesUpdateTemplate()

Update a template’s properties

var client = new PingramClient("your_api_key");
var templatePatchRequest = new ...; // see Request Body Properties below
await client.TemplatesApi.TemplatesUpdateTemplateAsync(templatePatchRequest);

Parameters

Request Body Properties

Types

TypesCreateNotificationType()

Create a new notification

var client = new PingramClient("your_api_key");
var notificationCreateRequest = new ...; // see Request Body Properties below
await client.TypesApi.TypesCreateNotificationTypeAsync(notificationCreateRequest);

Parameters

Request Body Properties

TypesDeleteNotificationType()

Delete a notification

var client = new PingramClient("your_api_key");
await client.TypesApi.TypesDeleteNotificationTypeAsync(...);

Parameters

Return Type

void (empty response body)

TypesGetNotificationType()

Get a specific notification by ID

var client = new PingramClient("your_api_key");
await client.TypesApi.TypesGetNotificationTypeAsync(...);

Parameters

TypesListNotificationTypes()

Get all notifications for an account with their templates

var client = new PingramClient("your_api_key");
await client.TypesApi.TypesListNotificationTypesAsync(...);

Parameters

This endpoint does not need any parameter.

TypesUpdateNotificationType()

Update a notification’s settings

var client = new PingramClient("your_api_key");
var notificationPatchRequest = new ...; // see Request Body Properties below
await client.TypesApi.TypesUpdateNotificationTypeAsync(notificationPatchRequest);

Parameters

Request Body Properties

User

UserGetAccountMetadata()

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

var client = new PingramClient("your_api_key");
await client.UserApi.UserGetAccountMetadataAsync(...);

Parameters

This endpoint does not need any parameter.

UserGetAvailableSlackChannels()

Get list of Slack channels and users for the authenticated user

var client = new PingramClient("your_api_key");
await client.UserApi.UserGetAvailableSlackChannelsAsync(...);

Parameters

Return Type

void (empty response body)

UserGetInAppNotifications()

Get in-app notifications for a user

var client = new PingramClient("your_api_key");
await client.UserApi.UserGetInAppNotificationsAsync(...);

Parameters

UserGetInAppUnreadCount()

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

var client = new PingramClient("your_api_key");
await client.UserApi.UserGetInAppUnreadCountAsync(...);

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.

var client = new PingramClient("your_api_key");
await client.UserApi.UserGetUserAsync(...);

Parameters

UserIdentify()

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

var client = new PingramClient("your_api_key");
var postUserRequest = new ...; // see Request Body Properties below
await client.UserApi.UserIdentifyAsync(postUserRequest);

Parameters

Request Body Properties

UserMarkInAppNotificationsAsSeen()

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

var client = new PingramClient("your_api_key");
var inAppNotificationUnreadClearRequest = new ...; // see Request Body Properties below
await client.UserApi.UserMarkInAppNotificationsAsSeenAsync(inAppNotificationUnreadClearRequest);

Parameters

Request Body Properties

UserUpdateInAppNotificationStatus()

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

var client = new PingramClient("your_api_key");
var inAppNotificationPatchRequest = new ...; // see Request Body Properties below
await client.UserApi.UserUpdateInAppNotificationStatusAsync(inAppNotificationPatchRequest);

Parameters

Request Body Properties

Users

UsersDeleteUser()

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

var client = new PingramClient("your_api_key");
await client.UsersApi.UsersDeleteUserAsync(...);

Parameters

UsersListUsers()

Get all users for an environment with pagination support

var client = new PingramClient("your_api_key");
await client.UsersApi.UsersListUsersAsync(...);

Parameters

UsersRemoveUserFromSuppression()

Remove user suppression status for a specific channel

var client = new PingramClient("your_api_key");
await client.UsersApi.UsersRemoveUserFromSuppressionAsync(...);

Parameters

Webhooks

WebhooksDeleteEventsWebhook()

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

var client = new PingramClient("your_api_key");
await client.WebhooksApi.WebhooksDeleteEventsWebhookAsync(...);

Parameters

This endpoint does not need any parameter.

Return Type

void (empty response body)

WebhooksGetEventsWebhook()

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

var client = new PingramClient("your_api_key");
await client.WebhooksApi.WebhooksGetEventsWebhookAsync(...);

Parameters

This endpoint does not need any parameter.

WebhooksUpsertEventsWebhook()

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

var client = new PingramClient("your_api_key");
var eventsWebhookUpsertRequest = new ...; // see Request Body Properties below
await client.WebhooksApi.WebhooksUpsertEventsWebhookAsync(eventsWebhookUpsertRequest);

Parameters

Request Body Properties