Python SDK

Setup & Initialization

1. Install Package:

pip install pingram-python

2. Import:

from pingram import Pingram, PingramRegion

3. Initialize and use as async context manager:

import asyncio

async def main():
    async with Pingram(api_key="pingram_sk_...") as client:
        # Use client methods here
        pass

asyncio.run(main())

* required

Region specific example:

import asyncio

async def main():
    async with Pingram(api_key="pingram_sk_...", region="eu") as client:
        # Use client methods here
        pass

asyncio.run(main())

Or using base_url directly:

import asyncio

async def main():
    async with Pingram(api_key="pingram_sk_...", base_url="https://api.eu.pingram.io") as client:
        # Use client methods here
        pass

asyncio.run(main())

Send

send()

Send a notification

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    sender_post_body = SenderPostBody()
    response = await client.send(sender_post_body)
    print(response)

Parameters

Request Body Properties

Addresses

addresses_create_address()

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.

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    create_address_request = CreateAddressRequest()
    response = await client.undefined.addresses_create_address(create_address_request)
    print(response)

Parameters

Request Body Properties

addresses_list_addresses()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.undefined.addresses_list_addresses()
    print(response)

Parameters

This endpoint does not need any parameter.

addresses_update_address()

Update an existing address

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    update_address_request = UpdateAddressRequest()
    response = await client.undefined.addresses_update_address(update_address_request)
    print(response)

Parameters

Request Body Properties

Domains

domains_add_domain()

Request to verify a new sender domain

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    post_senders_request_body = PostSendersRequestBody()
    response = await client.domains.domains_add_domain(post_senders_request_body)
    print(response)

Parameters

Request Body Properties

domains_delete_domain()

Delete a sender domain or email address

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    sender = 'sender_example'
    response = await client.domains.domains_delete_domain(sender)
    print(response)

Parameters

domains_list_domains()

Get all sender domains configured for the account

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.domains.domains_list_domains()
    print(response)

Parameters

This endpoint does not need any parameter.

Environments

environments_create_environment()

Create a new environment for the account

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    environment_create_request = EnvironmentCreateRequest()
    response = await client.environments.environments_create_environment(environment_create_request)
    print(response)

Parameters

Request Body Properties

environments_list_environments()

Get all environments for the authenticated account

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.environments.environments_list_environments()
    print(response)

Parameters

This endpoint does not need any parameter.

environments_update_environment()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    client_id = 'client_id_example'
    environment_patch_request = EnvironmentPatchRequest()
    response = await client.environments.environments_update_environment(client_id, environment_patch_request)
    print(response)

Parameters

Request Body Properties

Logs

logs_get_log_retention()

Get log retention period in days for the account

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.logs.logs_get_log_retention()
    print(response)

Parameters

This endpoint does not need any parameter.

logs_get_logs()

List logs for the authenticated account

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    limit = 3.4
    cursor = 'cursor_example'
    response = await client.logs.logs_get_logs(limit=limit, cursor=cursor)
    print(response)

Parameters

logs_get_logs_by_tracking_ids()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    tracking_ids = 'tracking_ids_example'
    response = await client.logs.logs_get_logs_by_tracking_ids(tracking_ids)
    print(response)

Parameters

logs_get_logs_query_result()

Get results from a query ID

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    query_id = 'query_id_example'
    response = await client.logs.logs_get_logs_query_result(query_id)
    print(response)

Parameters

logs_start_logs_query()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    log_query_post_body = LogQueryPostBody()
    response = await client.logs.logs_start_logs_query(log_query_post_body)
    print(response)

Parameters

Request Body Properties

logs_tail_logs()

Get last 100 logs from the stream

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.logs.logs_tail_logs()
    print(response)

Parameters

This endpoint does not need any parameter.

Organization

organization_get_usage()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.undefined.organization_get_usage()
    print(response)

Parameters

This endpoint does not need any parameter.

organization_get_usage_history()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    start_date = 'start_date_example'
    end_date = 'end_date_example'
    response = await client.undefined.organization_get_usage_history(start_date, end_date)
    print(response)

Parameters

PushSettings

push_settings_delete_push_apn_settings()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.undefined.push_settings_delete_push_apn_settings()
    print(response)

Parameters

This endpoint does not need any parameter.

push_settings_delete_push_fcm_settings()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.undefined.push_settings_delete_push_fcm_settings()
    print(response)

Parameters

This endpoint does not need any parameter.

push_settings_get_push_apn_settings()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.undefined.push_settings_get_push_apn_settings()
    print(response)

Parameters

This endpoint does not need any parameter.

push_settings_get_push_fcm_settings()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.undefined.push_settings_get_push_fcm_settings()
    print(response)

Parameters

This endpoint does not need any parameter.

push_settings_upsert_push_apn_settings()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    apn_config = APNConfig()
    response = await client.undefined.push_settings_upsert_push_apn_settings(apn_config)
    print(response)

Parameters

Request Body Properties

push_settings_upsert_push_fcm_settings()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    push_settings_fcm_put_request = PushSettingsFCMPutRequest()
    response = await client.undefined.push_settings_upsert_push_fcm_settings(push_settings_fcm_put_request)
    print(response)

Parameters

Request Body Properties

Sender

sender_delete_schedule()

Delete (unschedule) an already scheduled notification

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    tracking_id = 'tracking_id_example'
    response = await client.sender.sender_delete_schedule(tracking_id)
    print(response)

Parameters

sender_test_email()

Test the emailer with a sample email

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    post_email_test_request = PostEmailTestRequest()
    response = await client.sender.sender_test_email(post_email_test_request)
    print(response)

Parameters

Request Body Properties

sender_update_schedule()

Update the body or schedule of an already scheduled notification.

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    tracking_id = 'tracking_id_example'
    sender_post_body = SenderPostBody()
    response = await client.sender.sender_update_schedule(tracking_id, sender_post_body)
    print(response)

Parameters

Request Body Properties

Templates

templates_create_template()

Create a new template for a notification

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    notification_id = 'notification_id_example'
    channel = 'channel_example'
    template_post_request = TemplatePostRequest()
    response = await client.templates.templates_create_template(notification_id, channel, template_post_request)
    print(response)

Parameters

Request Body Properties

templates_delete_template()

Delete a template

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    notification_id = 'notification_id_example'
    channel = 'channel_example'
    template_id = 'template_id_example'
    response = await client.templates.templates_delete_template(notification_id, channel, template_id)
    print(response)

Parameters

templates_get_template()

Get a single template by ID

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    notification_id = 'notification_id_example'
    channel = 'channel_example'
    template_id = 'template_id_example'
    response = await client.templates.templates_get_template(notification_id, channel, template_id)
    print(response)

Parameters

templates_list_templates()

List all templates for a notification and channel

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    notification_id = 'notification_id_example'
    channel = 'channel_example'
    response = await client.templates.templates_list_templates(notification_id, channel)
    print(response)

Parameters

templates_set_default_template()

Set a template as default for specific delivery modes

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    notification_id = 'notification_id_example'
    channel = 'channel_example'
    set_default_template_request = SetDefaultTemplateRequest()
    response = await client.templates.templates_set_default_template(notification_id, channel, set_default_template_request)
    print(response)

Parameters

Request Body Properties

templates_update_template()

Update a template’s properties

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    notification_id = 'notification_id_example'
    channel = 'channel_example'
    template_id = 'template_id_example'
    template_patch_request = TemplatePatchRequest()
    response = await client.templates.templates_update_template(notification_id, channel, template_id, template_patch_request)
    print(response)

Parameters

Request Body Properties

Types

types_create_notification_type()

Create a new notification

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    notification_create_request = NotificationCreateRequest()
    response = await client.types.types_create_notification_type(notification_create_request)
    print(response)

Parameters

Request Body Properties

types_delete_notification_type()

Delete a notification

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    notification_id = 'notification_id_example'
    response = await client.types.types_delete_notification_type(notification_id)
    print(response)

Parameters

types_get_notification_type()

Get a specific notification by ID

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    notification_id = 'notification_id_example'
    response = await client.types.types_get_notification_type(notification_id)
    print(response)

Parameters

types_list_notification_types()

Get all notifications for an account with their templates

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.types.types_list_notification_types()
    print(response)

Parameters

This endpoint does not need any parameter.

types_update_notification_type()

Update a notification’s settings

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    notification_id = 'notification_id_example'
    notification_patch_request = NotificationPatchRequest()
    response = await client.types.types_update_notification_type(notification_id, notification_patch_request)
    print(response)

Parameters

Request Body Properties

User

user_generate_slack_oauth_path()

Complete Slack OAuth flow and store access token for user

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    user_id = 'user_id_example'
    slack_oauth_request = SlackOauthRequest()
    response = await client.user.user_generate_slack_oauth_path(user_id, slack_oauth_request)
    print(response)

Parameters

Request Body Properties

user_get_account_metadata()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.user.user_get_account_metadata()
    print(response)

Parameters

This endpoint does not need any parameter.

user_get_available_slack_channels()

Get list of Slack channels and users for the authenticated user

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    user_id = 'user_id_example'
    response = await client.user.user_get_available_slack_channels(user_id)
    print(response)

Parameters

user_get_in_app_notifications()

Get in-app notifications for a user

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    before = 'before_example'
    count = 3.4
    response = await client.user.user_get_in_app_notifications(before=before, count=count)
    print(response)

Parameters

user_get_in_app_unread_count()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.user.user_get_in_app_unread_count()
    print(response)

Parameters

This endpoint does not need any parameter.

user_get_user()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    user_id = 'user_id_example'
    response = await client.user.user_get_user(user_id)
    print(response)

Parameters

user_identify()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    user_id = 'user_id_example'
    post_user_request = PostUserRequest()
    response = await client.user.user_identify(user_id, post_user_request)
    print(response)

Parameters

Request Body Properties

user_mark_in_app_notifications_as_seen()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    in_app_notification_unread_clear_request = InAppNotificationUnreadClearRequest()
    response = await client.user.user_mark_in_app_notifications_as_seen(in_app_notification_unread_clear_request)
    print(response)

Parameters

Request Body Properties

user_update_in_app_notification_status()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    in_app_notification_patch_request = InAppNotificationPatchRequest()
    response = await client.user.user_update_in_app_notification_status(in_app_notification_patch_request)
    print(response)

Parameters

Request Body Properties

Users

users_delete_user()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    user_id = 'user_id_example'
    env_id = 'env_id_example'
    response = await client.users.users_delete_user(user_id, env_id=env_id)
    print(response)

Parameters

users_list_users()

Get all users for an environment with pagination support

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    limit = 3.4
    next_token = 'next_token_example'
    env_id = 'env_id_example'
    response = await client.users.users_list_users(limit, next_token, env_id=env_id)
    print(response)

Parameters

users_remove_user_from_suppression()

Remove user suppression status for a specific channel

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    user_id = 'user_id_example'
    channel = 'channel_example'
    env_id = 'env_id_example'
    response = await client.users.users_remove_user_from_suppression(user_id, channel, env_id=env_id)
    print(response)

Parameters

Webhooks

webhooks_delete_events_webhook()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.undefined.webhooks_delete_events_webhook()
    print(response)

Parameters

This endpoint does not need any parameter.

webhooks_get_events_webhook()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    response = await client.undefined.webhooks_get_events_webhook()
    print(response)

Parameters

This endpoint does not need any parameter.

webhooks_upsert_events_webhook()

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

from pingram import Pingram

async with Pingram(api_key="pingram_sk_...") as client:
    events_webhook_upsert_request = EventsWebhookUpsertRequest()
    response = await client.undefined.webhooks_upsert_events_webhook(events_webhook_upsert_request)
    print(response)

Parameters

Request Body Properties