Java SDK

Setup & Initialization

1. Add the Pingram dependency (Maven). Use the latest version on Maven Central:

<dependency>
    <groupId>io.pingram</groupId>
    <artifactId>pingram</artifactId>
    <version>1.0.0</version>
</dependency>

Or with Gradle:

implementation 'io.pingram:pingram:1.0.0'

2. Create the Pingram client with your API key:

import io.pingram.Pingram;

Pingram client = new Pingram("YOUR_API_KEY");

* required

Region example:

// EU or CA region
Pingram client = new Pingram("YOUR_API_KEY", Pingram.Region.EU);

Send

send()

Send a notification

SenderPostBody senderPostBody = new SenderPostBody(); // SenderPostBody | 
try {
    SenderPostResponse result = client.send(senderPostBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DefaultApi#send: " + e.getMessage());
}

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 createAddressRequest = new CreateAddressRequest(); // CreateAddressRequest | 
try {
    AddressResponse result = client.getAddresses().addressesCreateAddress(createAddressRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#addressesCreateAddress: " + e.getMessage());
}

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.

try {
    AccountAddressesResponse result = client.getAddresses().addressesListAddresses();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#addressesListAddresses: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

addressesUpdateAddress()

Update an existing address

UpdateAddressRequest updateAddressRequest = new UpdateAddressRequest(); // UpdateAddressRequest | 
try {
    AddressResponse result = client.getAddresses().addressesUpdateAddress(updateAddressRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#addressesUpdateAddress: " + e.getMessage());
}

Parameters

Request Body Properties

Domains

domainsAddDomain()

Request to verify a new sender domain

PostSendersRequestBody postSendersRequestBody = new PostSendersRequestBody(); // PostSendersRequestBody | 
try {
    List<GetSendersResponseInner> result = client.getDomains().domainsAddDomain(postSendersRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DomainsApi#domainsAddDomain: " + e.getMessage());
}

Parameters

Request Body Properties

domainsDeleteDomain()

Delete a sender domain or email address

String sender = "sender_example"; // String | Sender domain or email address (URL encoded)
try {
    SuccessResponse result = client.getDomains().domainsDeleteDomain(sender);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DomainsApi#domainsDeleteDomain: " + e.getMessage());
}

Parameters

domainsListDomains()

Get all sender domains configured for the account

try {
    List<GetSendersResponseInner> result = client.getDomains().domainsListDomains();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DomainsApi#domainsListDomains: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

Environments

environmentsCreateEnvironment()

Create a new environment for the account

EnvironmentCreateRequest environmentCreateRequest = new EnvironmentCreateRequest(); // EnvironmentCreateRequest | 
try {
    Environment result = client.getEnvironments().environmentsCreateEnvironment(environmentCreateRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EnvironmentsApi#environmentsCreateEnvironment: " + e.getMessage());
}

Parameters

Request Body Properties

environmentsListEnvironments()

Get all environments for the authenticated account

try {
    List<GetEnvironmentsResponseInner> result = client.getEnvironments().environmentsListEnvironments();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EnvironmentsApi#environmentsListEnvironments: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

environmentsUpdateEnvironment()

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

String clientId = "clientId_example"; // String | Environment client ID
EnvironmentPatchRequest environmentPatchRequest = new EnvironmentPatchRequest(); // EnvironmentPatchRequest | 
try {
    Environment result = client.getEnvironments().environmentsUpdateEnvironment(clientId, environmentPatchRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EnvironmentsApi#environmentsUpdateEnvironment: " + e.getMessage());
}

Parameters

Request Body Properties

Logs

logsGetLogRetention()

Get log retention period in days for the account

try {
    LogsRetentionResponse result = client.getLogs().logsGetLogRetention();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsGetLogRetention: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

logsGetLogs()

List logs for the authenticated account

BigDecimal limit = new BigDecimal(78); // BigDecimal | Maximum number of logs to return (default
String cursor = "cursor_example"; // String | Pagination cursor for next page
try {
    GetLogsResponse result = client.getLogs().logsGetLogs(limit, cursor);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsGetLogs: " + e.getMessage());
}

Parameters

logsGetLogsByTrackingIds()

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

String trackingIds = "trackingIds_example"; // String | Comma-separated tracking IDs (URL encoded)
try {
    LogsGetResponse result = client.getLogs().logsGetLogsByTrackingIds(trackingIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsGetLogsByTrackingIds: " + e.getMessage());
}

Parameters

logsGetLogsQueryResult()

Get results from a query ID

String queryId = "queryId_example"; // String | Query ID
try {
    LogsQueryResultResponse result = client.getLogs().logsGetLogsQueryResult(queryId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsGetLogsQueryResult: " + e.getMessage());
}

Parameters

logsStartLogsQuery()

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

LogQueryPostBody logQueryPostBody = new LogQueryPostBody(); // LogQueryPostBody | 
try {
    LogsQueryResponse result = client.getLogs().logsStartLogsQuery(logQueryPostBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsStartLogsQuery: " + e.getMessage());
}

Parameters

Request Body Properties

logsTailLogs()

Get last 100 logs from the stream

try {
    LogsTailResponse result = client.getLogs().logsTailLogs();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsTailLogs: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

Organization

organizationGetUsage()

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

try {
    OrganizationUsage result = client.getOrganization().organizationGetUsage();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationApi#organizationGetUsage: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

organizationGetUsageHistory()

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

String startDate = "startDate_example"; // String | Start date (YYYY-MM-DD) for the range
String endDate = "endDate_example"; // String | End date (YYYY-MM-DD) for the range
try {
    OrganizationUsageHistory result = client.getOrganization().organizationGetUsageHistory(startDate, endDate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationApi#organizationGetUsageHistory: " + e.getMessage());
}

Parameters

PushSettings

pushSettingsDeletePushApnSettings()

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

try {
    client.getPushSettings().pushSettingsDeletePushApnSettings();
} catch (ApiException e) {
    System.err.println("Exception when calling PushSettingsApi#pushSettingsDeletePushApnSettings: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

pushSettingsDeletePushFcmSettings()

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

try {
    client.getPushSettings().pushSettingsDeletePushFcmSettings();
} catch (ApiException e) {
    System.err.println("Exception when calling PushSettingsApi#pushSettingsDeletePushFcmSettings: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

pushSettingsGetPushApnSettings()

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

try {
    APNConfig result = client.getPushSettings().pushSettingsGetPushApnSettings();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PushSettingsApi#pushSettingsGetPushApnSettings: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

pushSettingsGetPushFcmSettings()

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

try {
    PushSettingsFCMResponse result = client.getPushSettings().pushSettingsGetPushFcmSettings();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PushSettingsApi#pushSettingsGetPushFcmSettings: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

pushSettingsUpsertPushApnSettings()

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

APNConfig apNConfig = new APNConfig(); // APNConfig | 
try {
    APNConfig result = client.getPushSettings().pushSettingsUpsertPushApnSettings(apNConfig);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PushSettingsApi#pushSettingsUpsertPushApnSettings: " + e.getMessage());
}

Parameters

Request Body Properties

pushSettingsUpsertPushFcmSettings()

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

PushSettingsFCMPutRequest pushSettingsFCMPutRequest = new PushSettingsFCMPutRequest(); // PushSettingsFCMPutRequest | 
try {
    PushSettingsFCMResponse result = client.getPushSettings().pushSettingsUpsertPushFcmSettings(pushSettingsFCMPutRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PushSettingsApi#pushSettingsUpsertPushFcmSettings: " + e.getMessage());
}

Parameters

Request Body Properties

Sender

senderDeleteSchedule()

Delete (unschedule) an already scheduled notification

String trackingId = "trackingId_example"; // String | The tracking ID of the scheduled notification
try {
    MessageResponse result = client.getSender().senderDeleteSchedule(trackingId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SenderApi#senderDeleteSchedule: " + e.getMessage());
}

Parameters

senderTestEmail()

Test the emailer with a sample email

PostEmailTestRequest postEmailTestRequest = new PostEmailTestRequest(); // PostEmailTestRequest | 
try {
    PostEmailTestResponse result = client.getSender().senderTestEmail(postEmailTestRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SenderApi#senderTestEmail: " + e.getMessage());
}

Parameters

Request Body Properties

senderUpdateSchedule()

Update the body or schedule of an already scheduled notification.

String trackingId = "trackingId_example"; // String | The tracking ID of the scheduled notification
SenderPostBody senderPostBody = new SenderPostBody(); // SenderPostBody | 
try {
    MessageResponse result = client.getSender().senderUpdateSchedule(trackingId, senderPostBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SenderApi#senderUpdateSchedule: " + e.getMessage());
}

Parameters

Request Body Properties

Templates

templatesCreateTemplate()

Create a new template for a notification

String notificationId = "notificationId_example"; // String | Notification ID
String channel = "channel_example"; // String | Channel type
TemplatePostRequest templatePostRequest = new TemplatePostRequest(); // TemplatePostRequest | 
try {
    Template result = client.getTemplates().templatesCreateTemplate(notificationId, channel, templatePostRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TemplatesApi#templatesCreateTemplate: " + e.getMessage());
}

Parameters

Request Body Properties

templatesDeleteTemplate()

Delete a template

String notificationId = "notificationId_example"; // String | Notification ID
String channel = "channel_example"; // String | Channel type
String templateId = "templateId_example"; // String | Template ID
try {
    client.getTemplates().templatesDeleteTemplate(notificationId, channel, templateId);
} catch (ApiException e) {
    System.err.println("Exception when calling TemplatesApi#templatesDeleteTemplate: " + e.getMessage());
}

Parameters

templatesGetTemplate()

Get a single template by ID

String notificationId = "notificationId_example"; // String | Notification ID
String channel = "channel_example"; // String | Channel type
String templateId = "templateId_example"; // String | Template ID
try {
    GetTemplatesResponse result = client.getTemplates().templatesGetTemplate(notificationId, channel, templateId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TemplatesApi#templatesGetTemplate: " + e.getMessage());
}

Parameters

templatesListTemplates()

List all templates for a notification and channel

String notificationId = "notificationId_example"; // String | Notification ID
String channel = "channel_example"; // String | Channel type
try {
    List<GetTemplatesListResponseInner> result = client.getTemplates().templatesListTemplates(notificationId, channel);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TemplatesApi#templatesListTemplates: " + e.getMessage());
}

Parameters

templatesSetDefaultTemplate()

Set a template as default for specific delivery modes

String notificationId = "notificationId_example"; // String | Notification ID
String channel = "channel_example"; // String | Channel type
SetDefaultTemplateRequest setDefaultTemplateRequest = new SetDefaultTemplateRequest(); // SetDefaultTemplateRequest | 
try {
    Template result = client.getTemplates().templatesSetDefaultTemplate(notificationId, channel, setDefaultTemplateRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TemplatesApi#templatesSetDefaultTemplate: " + e.getMessage());
}

Parameters

Request Body Properties

templatesUpdateTemplate()

Update a template’s properties

String notificationId = "notificationId_example"; // String | Notification ID
String channel = "channel_example"; // String | Channel type
String templateId = "templateId_example"; // String | Template ID
TemplatePatchRequest templatePatchRequest = new TemplatePatchRequest(); // TemplatePatchRequest | 
try {
    Template result = client.getTemplates().templatesUpdateTemplate(notificationId, channel, templateId, templatePatchRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TemplatesApi#templatesUpdateTemplate: " + e.getMessage());
}

Parameters

Request Body Properties

Types

typesCreateNotificationType()

Create a new notification

NotificationCreateRequest notificationCreateRequest = new NotificationCreateRequest(); // NotificationCreateRequest | 
try {
    Notification result = client.getTypes().typesCreateNotificationType(notificationCreateRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TypesApi#typesCreateNotificationType: " + e.getMessage());
}

Parameters

Request Body Properties

typesDeleteNotificationType()

Delete a notification

String notificationId = "notificationId_example"; // String | The notification ID
try {
    client.getTypes().typesDeleteNotificationType(notificationId);
} catch (ApiException e) {
    System.err.println("Exception when calling TypesApi#typesDeleteNotificationType: " + e.getMessage());
}

Parameters

typesGetNotificationType()

Get a specific notification by ID

String notificationId = "notificationId_example"; // String | The notification ID
try {
    List<GetNotificationsResponseInner> result = client.getTypes().typesGetNotificationType(notificationId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TypesApi#typesGetNotificationType: " + e.getMessage());
}

Parameters

typesListNotificationTypes()

Get all notifications for an account with their templates

try {
    List<GetNotificationsResponseInner> result = client.getTypes().typesListNotificationTypes();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TypesApi#typesListNotificationTypes: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

typesUpdateNotificationType()

Update a notification’s settings

String notificationId = "notificationId_example"; // String | The notification ID
NotificationPatchRequest notificationPatchRequest = new NotificationPatchRequest(); // NotificationPatchRequest | 
try {
    Notification result = client.getTypes().typesUpdateNotificationType(notificationId, notificationPatchRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TypesApi#typesUpdateNotificationType: " + e.getMessage());
}

Parameters

Request Body Properties

User

userGenerateSlackOauthPath()

Complete Slack OAuth flow and store access token for user

String userId = "userId_example"; // String | User ID
SlackOauthRequest slackOauthRequest = new SlackOauthRequest(); // SlackOauthRequest | 
try {
    client.getUser().userGenerateSlackOauthPath(userId, slackOauthRequest);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userGenerateSlackOauthPath: " + e.getMessage());
}

Parameters

Request Body Properties

userGetAccountMetadata()

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

try {
    GetAccountMetadataResponse result = client.getUser().userGetAccountMetadata();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userGetAccountMetadata: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

userGetAvailableSlackChannels()

Get list of Slack channels and users for the authenticated user

String userId = "userId_example"; // String | User ID
try {
    client.getUser().userGetAvailableSlackChannels(userId);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userGetAvailableSlackChannels: " + e.getMessage());
}

Parameters

userGetInAppNotifications()

Get in-app notifications for a user

String before = "before_example"; // String | Timestamp or ISO date to fetch notifications before
BigDecimal count = new BigDecimal(78); // BigDecimal | Number of notifications to return (default 10)
try {
    GetInappNotificationsResponse result = client.getUser().userGetInAppNotifications(before, count);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userGetInAppNotifications: " + e.getMessage());
}

Parameters

userGetInAppUnreadCount()

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

try {
    InappUnreadCountResponse result = client.getUser().userGetInAppUnreadCount();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userGetInAppUnreadCount: " + e.getMessage());
}

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.

String userId = "userId_example"; // String | User ID
try {
    User result = client.getUser().userGetUser(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userGetUser: " + e.getMessage());
}

Parameters

userIdentify()

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

String userId = "userId_example"; // String | User ID
PostUserRequest postUserRequest = new PostUserRequest(); // PostUserRequest | 
try {
    User result = client.getUser().userIdentify(userId, postUserRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userIdentify: " + e.getMessage());
}

Parameters

Request Body Properties

userMarkInAppNotificationsAsSeen()

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

InAppNotificationUnreadClearRequest inAppNotificationUnreadClearRequest = new InAppNotificationUnreadClearRequest(); // InAppNotificationUnreadClearRequest | 
try {
    SuccessResponse result = client.getUser().userMarkInAppNotificationsAsSeen(inAppNotificationUnreadClearRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userMarkInAppNotificationsAsSeen: " + e.getMessage());
}

Parameters

Request Body Properties

userUpdateInAppNotificationStatus()

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

InAppNotificationPatchRequest inAppNotificationPatchRequest = new InAppNotificationPatchRequest(); // InAppNotificationPatchRequest | 
try {
    SuccessResponse result = client.getUser().userUpdateInAppNotificationStatus(inAppNotificationPatchRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userUpdateInAppNotificationStatus: " + e.getMessage());
}

Parameters

Request Body Properties

Users

usersDeleteUser()

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

String userId = "userId_example"; // String | User ID
String envId = "envId_example"; // String | Environment ID (required when using JWT auth)
try {
    DeleteUserResponse result = client.getUsers().usersDeleteUser(userId, envId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#usersDeleteUser: " + e.getMessage());
}

Parameters

usersListUsers()

Get all users for an environment with pagination support

BigDecimal limit = new BigDecimal(78); // BigDecimal | Maximum number of users to return (default
String nextToken = "nextToken_example"; // String | Pagination token for next page
String envId = "envId_example"; // String | Environment ID (required when using JWT auth)
try {
    GetUsersResponse result = client.getUsers().usersListUsers(limit, nextToken, envId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#usersListUsers: " + e.getMessage());
}

Parameters

usersRemoveUserFromSuppression()

Remove user suppression status for a specific channel

String userId = "userId_example"; // String | User ID
String channel = "channel_example"; // String | Channel type (EMAIL)
String envId = "envId_example"; // String | Environment ID (required when using JWT auth)
try {
    UserSuppressionDeleteResponse result = client.getUsers().usersRemoveUserFromSuppression(userId, channel, envId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#usersRemoveUserFromSuppression: " + e.getMessage());
}

Parameters

Webhooks

webhooksDeleteEventsWebhook()

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

try {
    client.getWebhooks().webhooksDeleteEventsWebhook();
} catch (ApiException e) {
    System.err.println("Exception when calling WebhooksApi#webhooksDeleteEventsWebhook: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

webhooksGetEventsWebhook()

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

try {
    EventsWebhookResponse result = client.getWebhooks().webhooksGetEventsWebhook();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WebhooksApi#webhooksGetEventsWebhook: " + e.getMessage());
}

Parameters

This endpoint does not need any parameter.

webhooksUpsertEventsWebhook()

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

EventsWebhookUpsertRequest eventsWebhookUpsertRequest = new EventsWebhookUpsertRequest(); // EventsWebhookUpsertRequest | 
try {
    EventsWebhookResponse result = client.getWebhooks().webhooksUpsertEventsWebhook(eventsWebhookUpsertRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WebhooksApi#webhooksUpsertEventsWebhook: " + e.getMessage());
}

Parameters

Request Body Properties