Node.js SDK

Setup & Initialization

1. Install using one of the following package managers:

npm install pingram

yarn add pingram

pnpm add pingram

2. Import:

import { Pingram } from 'pingram';

3. Initialize:

const pingram = new Pingram({
  apiKey: 'pingram_sk_...' // Your API key from the dashboard
});

• required

Region specific example:

import { Pingram } from 'pingram';

const pingram = new Pingram({
  apiKey: 'pingram_sk_...',
  baseURL: 'https://api.eu.pingram.io'
});

Send

send()

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

// Request body only
await pingram.send({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | —————— | ––––––– | ——————————— | — | | senderPostBody | SenderPostBody | See Request Body Properties below | |

Request Body Properties

Webhooks

deleteEventsWebhook()

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

// No parameters
await pingram.webhooks.deleteEventsWebhook();

Parameters

This endpoint does not need any parameter.

getEventsWebhook()

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

// No parameters
await pingram.webhooks.getEventsWebhook();

Parameters

This endpoint does not need any parameter.

upsertEventsWebhook()

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

// Request body only
await pingram.webhooks.upsertEventsWebhook({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | —————————— | ––––––––––––– | ——————————— | — | | eventsWebhookUpsertRequest | EventsWebhookUpsertRequest | See Request Body Properties below | |

Request Body Properties

Addresses

createAddress()

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

// Request body only
await pingram.addresses.createAddress({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ———————— | –––––––––– | ——————————— | — | | createAddressRequest | CreateAddressRequest | See Request Body Properties below | |

Request Body Properties

deleteAddress()

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

// Path parameter only
await pingram.addresses.deleteAddress('fullAddress_example');

Parameters

listAddresses()

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

// No parameters
await pingram.addresses.listAddresses();

Parameters

This endpoint does not need any parameter.

updateAddress()

Update an inbox prefix or display name.

// Request body only
await pingram.addresses.updateAddress({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ———————— | –––––––––– | ——————————— | — | | updateAddressRequest | UpdateAddressRequest | See Request Body Properties below | |

Request Body Properties

Domains

addDomain()

Add and start verification for a new sender domain. Pass the domain only (not a full email address).

// Request body only
await pingram.domains.addDomain({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ––––––––––––– | ––––––––––– | ——————————— | — | | postSendersRequestBody | PostSendersRequestBody | See Request Body Properties below | |

Request Body Properties

deleteDomain()

Remove a sender domain from the account.

// Path parameter only
await pingram.domains.deleteDomain('sender_example');

Parameters

listDomains()

List sender domains configured for the account (for outbound email).

// No parameters
await pingram.domains.listDomains();

Parameters

This endpoint does not need any parameter.

startDomainVerification()

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

// Path parameter only
await pingram.domains.startDomainVerification('sender_example');

Parameters

Email

send()

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

// Request body only
await pingram.email.send({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | –––––––––– | –––––––– | ——————————— | — | | sendEmailRequest | SendEmailRequest | See Request Body Properties below | |

Request Body Properties

Environments

createEnvironment()

Create a new environment for the account

// Request body only
await pingram.environments.createEnvironment({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | –––––––––––––– | ———————— | ——————————— | — | | environmentCreateRequest | EnvironmentCreateRequest | See Request Body Properties below | |

Request Body Properties

listEnvironments()

Get all environments for the authenticated account

// No parameters
await pingram.environments.listEnvironments();

Parameters

This endpoint does not need any parameter.

updateEnvironment()

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

// Path parameter + request body
await pingram.environments.updateEnvironment('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ————————— | ———————– | ——————————— | — | | clientId | string | Environment client ID | | environmentPatchRequest | EnvironmentPatchRequest | See Request Body Properties below | |

Request Body Properties

Logs

getLogRetention()

Get log retention period in days for the account

// No parameters
await pingram.logs.getLogRetention();

Parameters

This endpoint does not need any parameter.

getLogs()

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

// No parameters
await pingram.logs.getLogs();

Parameters

getLogsByTrackingIds()

Get logs by tracking IDs (comma-separated, max 25 IDs). Use after sending email or SMS to look up delivery status.

// Path parameter only
await pingram.logs.getLogsByTrackingIds('trackingIds_example');

Parameters

getLogsQueryResult()

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

// Path parameter only
await pingram.logs.getLogsQueryResult('queryId_example');

Parameters

startLogsQuery()

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

// Request body only
await pingram.logs.startLogsQuery({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | –––––––––– | –––––––– | ——————————— | — | | logQueryPostBody | LogQueryPostBody | See Request Body Properties below | |

Request Body Properties

tailLogs()

Get last 100 logs from the stream

// No parameters
await pingram.logs.tailLogs();

Parameters

This endpoint does not need any parameter.

Numbers

list()

List active phone numbers registered for the account.

// No parameters
await pingram.numbers.list();

Parameters

This endpoint does not need any parameter.

listReleased()

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

// No parameters
await pingram.numbers.listReleased();

Parameters

This endpoint does not need any parameter.

orderNumber()

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

// Request body only
await pingram.numbers.orderNumber({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ————————— | ———————– | ——————————— | — | | orderPhoneNumberRequest | OrderPhoneNumberRequest | See Request Body Properties below | |

Request Body Properties

releaseNumber()

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

// Path parameter only
await pingram.numbers.releaseNumber('phoneNumber_example');

Parameters

searchAvailable()

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

// No parameters
await pingram.numbers.searchAvailable();

Parameters

Organization

create()

Create organization after SMS verification bypass

// No parameters
await pingram.organization.create();

Parameters

This endpoint does not need any parameter.

getUsage()

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

// No parameters
await pingram.organization.getUsage();

Parameters

This endpoint does not need any parameter.

getUsageHistory()

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

// No parameters
await pingram.organization.getUsageHistory();

Parameters

Profile

acceptInvite()

Accept a team invitation using a token

// Request body only
await pingram.profile.acceptInvite({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ———————– | —————–– | ——————————— | — | | acceptInviteRequest | AcceptInviteRequest | See Request Body Properties below | |

Request Body Properties

changeEmail()

Change the email address of the authenticated user

// Request body only
await pingram.profile.changeEmail({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ––––––––––– | —————— | ——————————— | — | | changeEmailRequest | ChangeEmailRequest | See Request Body Properties below | |

Request Body Properties

deleteAccount()

Permanently delete the authenticated user's account

// Request body only
await pingram.profile.deleteAccount({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ———————— | –––––––––– | ——————————— | — | | deleteAccountRequest | DeleteAccountRequest | See Request Body Properties below | |

Request Body Properties

disableMfa()

Disable MFA for the authenticated user

// Path parameter only
await pingram.profile.disableMfa('type_example');

Parameters

getMfaStatus()

Get MFA status for the authenticated user

// No parameters
await pingram.profile.getMfaStatus();

Parameters

This endpoint does not need any parameter.

setupMfa()

Start TOTP MFA setup and return QR code data

// Request body only
await pingram.profile.setupMfa({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | —————–– | ————— | ——————————— | — | | mFASetupRequest | MFASetupRequest | See Request Body Properties below | |

Request Body Properties

verifyMfa()

Verify TOTP code and enable MFA

// Request body only
await pingram.profile.verifyMfa({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | –––––––––– | –––––––– | ——————————— | — | | mFAVerifyRequest | MFAVerifyRequest | See Request Body Properties below | |

Request Body Properties

PushSettings

deletePushApnSettings()

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

// No parameters
await pingram.pushSettings.deletePushApnSettings();

Parameters

This endpoint does not need any parameter.

deletePushFcmSettings()

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

// No parameters
await pingram.pushSettings.deletePushFcmSettings();

Parameters

This endpoint does not need any parameter.

getPushApnSettings()

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

// No parameters
await pingram.pushSettings.getPushApnSettings();

Parameters

This endpoint does not need any parameter.

getPushFcmSettings()

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

// No parameters
await pingram.pushSettings.getPushFcmSettings();

Parameters

This endpoint does not need any parameter.

upsertPushApnSettings()

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

// Request body only
await pingram.pushSettings.upsertPushApnSettings({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ———–– | ——— | ——————————— | — | | aPNConfig | APNConfig | See Request Body Properties below | |

Request Body Properties

upsertPushFcmSettings()

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

// Request body only
await pingram.pushSettings.upsertPushFcmSettings({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | —————————– | ———————–– | ——————————— | — | | pushSettingsFCMPutRequest | PushSettingsFCMPutRequest | See Request Body Properties below | |

Request Body Properties

Sender

deleteSchedule()

Delete (unschedule) an already scheduled notification

// Path parameter only
await pingram.sender.deleteSchedule('trackingId_example');

Parameters

updateSchedule()

Update the body or schedule of an already scheduled notification.

// Path parameter + request body
await pingram.sender.updateSchedule('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | —————— | ––––––– | ——————————————— | — | | trackingId | string | The tracking ID of the scheduled notification | | senderPostBody | SenderPostBody | See Request Body Properties below | |

Request Body Properties

Sms

send()

Send an SMS or MMS directly without a template. Requires `type` and `to`. Pass `message` and/or `mediaUrls`. Optional: `from`, `schedule`.

// Request body only
await pingram.sms.send({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | —————— | ––––––– | ——————————— | — | | sendSmsRequest | SendSmsRequest | See Request Body Properties below | |

Request Body Properties

Templates

createTemplate()

Create a new template for a notification

// Path parameter + request body
await pingram.templates.createTemplate('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ———————– | —————–– | ——————————— | — | | notificationId | string | Notification ID | | channel | string | Channel type | | templatePostRequest | TemplatePostRequest | See Request Body Properties below | |

Request Body Properties

deleteTemplate()

Delete a template

// Path parameter only
await pingram.templates.deleteTemplate('notificationId_example');

Parameters

getTemplate()

Get a single template by ID

// Path parameter only
await pingram.templates.getTemplate('notificationId_example');

Parameters

listTemplates()

List all templates for a notification and channel

// Path parameter only
await pingram.templates.listTemplates('notificationId_example');

Parameters

setDefaultTemplate()

Set a template as default for specific delivery modes

// Path parameter + request body
await pingram.templates.setDefaultTemplate('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | —————————– | ———————–– | ——————————— | — | | notificationId | string | Notification ID | | channel | string | Channel type | | setDefaultTemplateRequest | SetDefaultTemplateRequest | See Request Body Properties below | |

Request Body Properties

updateTemplate()

Update a template's properties

// Path parameter + request body
await pingram.templates.updateTemplate('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ———————— | –––––––––– | ——————————— | — | | notificationId | string | Notification ID | | channel | string | Channel type | | templateId | string | Template ID | | templatePatchRequest | TemplatePatchRequest | See Request Body Properties below | |

Request Body Properties

Types

createNotificationType()

Create a new notification

// Request body only
await pingram.types.createNotificationType({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | —————————– | ———————–– | ——————————— | — | | notificationCreateRequest | NotificationCreateRequest | See Request Body Properties below | |

Request Body Properties

deleteNotificationType()

Delete a notification

// Path parameter only
await pingram.types.deleteNotificationType('notificationId_example');

Parameters

getNotificationType()

Get a specific notification by ID

// Path parameter only
await pingram.types.getNotificationType('notificationId_example');

Parameters

listNotificationTypes()

Get all notifications for an account with their templates

// No parameters
await pingram.types.listNotificationTypes();

Parameters

This endpoint does not need any parameter.

updateNotificationType()

Update a notification's settings

// Path parameter + request body
await pingram.types.updateNotificationType('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | –––––––––––––– | ———————— | ——————————— | — | | notificationId | string | The notification ID | | notificationPatchRequest | NotificationPatchRequest | See Request Body Properties below | |

Request Body Properties

| Name | Type | Description | | —————————————— | –––––––––––––––––––––––––––––––––––––––– | ———– | — | | title | string | | | channels | (“EMAIL” | “INAPP_WEB” | “SMS” | “CALL” | “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.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” | |

User

getAccountMetadata()

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

// No parameters
await pingram.user.getAccountMetadata();

Parameters

This endpoint does not need any parameter.

getAvailableSlackChannels()

Get list of Slack channels and users for the authenticated user

// Path parameter only
await pingram.user.getAvailableSlackChannels('userId_example');

Parameters

getInAppNotifications()

Get in-app notifications for a user

// No parameters
await pingram.user.getInAppNotifications();

Parameters

getInAppUnreadCount()

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

// No parameters
await pingram.user.getInAppUnreadCount();

Parameters

This endpoint does not need any parameter.

getUser()

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

// Path parameter only
await pingram.user.getUser('userId_example');

Parameters

identify()

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

// Path parameter + request body
await pingram.user.identify('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | —————–– | ————— | ——————————— | — | | userId | string | User ID | | postUserRequest | PostUserRequest | See Request Body Properties below | |

Request Body Properties

markInAppNotificationsAsSeen()

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

// Request body only
await pingram.user.markInAppNotificationsAsSeen({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ————————————— | ———————————– | ——————————— | — | | inAppNotificationUnreadClearRequest | InAppNotificationUnreadClearRequest | See Request Body Properties below | |

Request Body Properties

updateInAppNotificationStatus()

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

// Request body only
await pingram.user.updateInAppNotificationStatus({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

| Name | Type | Description | | ——————————— | —————————– | ——————————— | — | | inAppNotificationPatchRequest | InAppNotificationPatchRequest | See Request Body Properties below | |

Request Body Properties

Users

deleteUser()

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

// Path parameter only
await pingram.users.deleteUser('userId_example');

Parameters

listUsers()

Get all users for an environment with pagination support

// No parameters
await pingram.users.listUsers();

Parameters

removeUserFromSuppression()

Remove user suppression status for a specific channel

// Path parameter only
await pingram.users.removeUserFromSuppression('userId_example');

Parameters