> Source: https://www.pingram.io/docs/api-reference/

# Overview

## Pingram 1.0.0

Internal API for notification delivery and management

Information

-   OpenAPI version: `3.0.0`

## Operations

GET

[/account](/docs/api-reference/operations/account_getaccountdetails/)

PATCH

[/account](/docs/api-reference/operations/account_updateaccountsettings/)

GET

[/account/billing-email](/docs/api-reference/operations/account_getbillingemail/)

PATCH

[/account/billing-email](/docs/api-reference/operations/account_updatebillingemail/)

GET

[/account/invoices](/docs/api-reference/operations/account_listinvoices/)

GET

[/account/payment-methods](/docs/api-reference/operations/account_listpaymentmethods/)

POST

[/account/payment-methods/assign](/docs/api-reference/operations/account_assignpaymentmethod/)

POST

[/account/payment-methods/setup](/docs/api-reference/operations/account_createpaymentmethodsetup/)

POST

[/account/subscription/cancel](/docs/api-reference/operations/account_cancelsubscription/)

POST

[/account/subscription/resume](/docs/api-reference/operations/account_resumesubscription/)

DELETE

[/account/supabase](/docs/api-reference/operations/account_revokesupabase/)

POST

[/account/supabase/configure](/docs/api-reference/operations/account_configuresupabasesmtp/)

POST

[/account/supabase/oauth](/docs/api-reference/operations/account_supabaseoauth/)

GET

[/account/supabase/projects](/docs/api-reference/operations/account_listsupabaseprojects/)

GET

[/account/supabase/status](/docs/api-reference/operations/account_getsupabasestatus/)

GET

[/account/usage](/docs/api-reference/operations/account_getusage/)

GET

[/account/usage/history](/docs/api-reference/operations/account_getusagehistory/)

POST

[/billing](/docs/api-reference/operations/account_preparecheckoutsession/)

GET

[/accounts](/docs/api-reference/operations/accounts_listaccounts/)

POST

[/accounts](/docs/api-reference/operations/accounts_createaccount/)

PATCH

[/accounts/{accountId}](/docs/api-reference/operations/accounts_updateaccount/)

GET

[/broadcasts](/docs/api-reference/operations/broadcasts_list/)

POST

[/broadcasts](/docs/api-reference/operations/broadcasts_create/)

GET

[/broadcasts/{broadcastId}](/docs/api-reference/operations/broadcasts_get/)

DELETE

[/broadcasts/{broadcastId}](/docs/api-reference/operations/broadcasts_delete/)

PATCH

[/broadcasts/{broadcastId}](/docs/api-reference/operations/broadcasts_update/)

POST

[/broadcasts/{broadcastId}/archive](/docs/api-reference/operations/broadcasts_archive/)

POST

[/broadcasts/{broadcastId}/cancel](/docs/api-reference/operations/broadcasts_cancel/)

GET

[/broadcasts/{broadcastId}/metrics](/docs/api-reference/operations/broadcasts_getmetrics/)

POST

[/broadcasts/{broadcastId}/pause](/docs/api-reference/operations/broadcasts_pause/)

GET

[/broadcasts/{broadcastId}/recipients](/docs/api-reference/operations/broadcasts_listrecipients/)

POST

[/broadcasts/{broadcastId}/resume](/docs/api-reference/operations/broadcasts_resume/)

POST

[/broadcasts/{broadcastId}/schedule](/docs/api-reference/operations/broadcasts_schedule/)

POST

[/broadcasts/{broadcastId}/send](/docs/api-reference/operations/broadcasts_send/)

POST

[/broadcasts/{broadcastId}/unarchive](/docs/api-reference/operations/broadcasts_unarchive/)

GET

[/components](/docs/api-reference/operations/components_listcomponents/)

POST

[/components](/docs/api-reference/operations/components_createcomponent/)

GET

[/components/{componentId}](/docs/api-reference/operations/components_getcomponent/)

DELETE

[/components/{componentId}](/docs/api-reference/operations/components_deletecomponent/)

PATCH

[/components/{componentId}](/docs/api-reference/operations/components_patchcomponent/)

GET

[/components/public](/docs/api-reference/operations/components_listcomponentsparsed/)

GET

[/domains](/docs/api-reference/operations/domains_listdomains/)

POST

[/domains](/docs/api-reference/operations/domains_adddomain/)

DELETE

[/domains/{sender}](/docs/api-reference/operations/domains_deletedomain/)

POST

[/domains/{sender}/start-verification](/docs/api-reference/operations/domains_startdomainverification/)

POST

[/editor/token](/docs/api-reference/operations/editor_generateeditortoken/)

POST

[/email](/docs/api-reference/operations/email_send/)

DELETE

[/email/suppressions/{reason}](/docs/api-reference/operations/email_deletesuppressions/)

GET

[/environments](/docs/api-reference/operations/environments_listenvironments/)

PATCH

[/environments/{clientId}](/docs/api-reference/operations/environments_updateenvironment/)

GET

[/status](/docs/api-reference/operations/health_healthcheck/)

POST

[/insights](/docs/api-reference/operations/insights_queryinsights/)

GET

[/keys](/docs/api-reference/operations/keys_listapikeys/)

POST

[/keys](/docs/api-reference/operations/keys_createapikey/)

DELETE

[/keys/{keyId}](/docs/api-reference/operations/keys_revokeapikey/)

GET

[/library/{useCase}](/docs/api-reference/operations/library_list/)

POST

[/library/{useCase}](/docs/api-reference/operations/library_create/)

GET

[/logs](/docs/api-reference/operations/logs_getlogs/)

GET

[/logs/{trackingIds}](/docs/api-reference/operations/logs_getlogsbytrackingids/)

POST

[/logs/query](/docs/api-reference/operations/logs_startlogsquery/)

GET

[/logs/query/{queryId}](/docs/api-reference/operations/logs_getlogsqueryresult/)

GET

[/logs/retention](/docs/api-reference/operations/logs_getlogretention/)

POST

[/logs/retry/{trackingId}](/docs/api-reference/operations/logs_retryinbound/)

GET

[/logs/status/{trackingIds}](/docs/api-reference/operations/logs_getdeliverystatus/)

GET

[/logs/tail](/docs/api-reference/operations/logs_taillogs/)

GET

[/members](/docs/api-reference/operations/members_listmembers/)

POST

[/members](/docs/api-reference/operations/members_invitemember/)

DELETE

[/members/{userId}](/docs/api-reference/operations/members_removemember/)

PATCH

[/members/{userId}](/docs/api-reference/operations/members_update/)

GET

[/members/autojoin](/docs/api-reference/operations/members_getautojoin/)

POST

[/members/autojoin](/docs/api-reference/operations/members_setautojoin/)

DELETE

[/numbers/{phoneNumber}](/docs/api-reference/operations/numbers_releasenumber/)

GET

[/numbers/available](/docs/api-reference/operations/numbers_searchavailable/)

GET

[/numbers/list](/docs/api-reference/operations/numbers_list/)

POST

[/numbers/order](/docs/api-reference/operations/numbers_ordernumber/)

GET

[/numbers/released](/docs/api-reference/operations/numbers_listreleased/)

POST

[/profile/accept\_invite](/docs/api-reference/operations/profile_acceptinvite/)

POST

[/profile/delete-account](/docs/api-reference/operations/profile_deleteaccount/)

GET

[/profile/mfa](/docs/api-reference/operations/profile_getmfastatus/)

POST

[/profile/mfa](/docs/api-reference/operations/profile_setupmfa/)

DELETE

[/profile/mfa/{type}](/docs/api-reference/operations/profile_disablemfa/)

POST

[/profile/mfa/verify](/docs/api-reference/operations/profile_verifymfa/)

GET

[/registrations/us/10dlc/brand](/docs/api-reference/operations/registrations_getus10dlcbrand/)

POST

[/registrations/us/10dlc/brand](/docs/api-reference/operations/registrations_createus10dlcbrand/)

PATCH

[/registrations/us/10dlc/brand](/docs/api-reference/operations/registrations_updateus10dlcbrand/)

GET

[/registrations/us/10dlc/campaign](/docs/api-reference/operations/registrations_getus10dlccampaign/)

PATCH

[/registrations/us/10dlc/campaign](/docs/api-reference/operations/registrations_updateus10dlccampaign/)

PUT

[/sender/scheduler/{trackingId}](/docs/api-reference/operations/sender_updateschedule/)

DELETE

[/sender/scheduler/{trackingId}](/docs/api-reference/operations/sender_deleteschedule/)

POST

[/sender/test/email](/docs/api-reference/operations/sender_testemail/)

POST

[/sms](/docs/api-reference/operations/sms_send/)

PUT

[/notifications/{notificationId}/subNotifications/{subNotificationId}](/docs/api-reference/operations/subnotifications_putsubnotification/)

DELETE

[/notifications/{notificationId}/subNotifications/{subNotificationId}](/docs/api-reference/operations/subnotifications_deletesubnotification/)

GET

[/notifications/{notificationId}/{channel}/templates](/docs/api-reference/operations/templates_listtemplates/)

POST

[/notifications/{notificationId}/{channel}/templates](/docs/api-reference/operations/templates_createtemplate/)

GET

[/notifications/{notificationId}/{channel}/templates/{templateId}](/docs/api-reference/operations/templates_gettemplate/)

DELETE

[/notifications/{notificationId}/{channel}/templates/{templateId}](/docs/api-reference/operations/templates_deletetemplate/)

PATCH

[/notifications/{notificationId}/{channel}/templates/{templateId}](/docs/api-reference/operations/templates_updatetemplate/)

PATCH

[/notifications/{notificationId}/{channel}/templates/default-selection](/docs/api-reference/operations/templates_setdefaulttemplate/)

GET

[/types](/docs/api-reference/operations/types_listnotificationtypes/)

POST

[/types](/docs/api-reference/operations/types_createnotificationtype/)

GET

[/types/{notificationId}](/docs/api-reference/operations/types_getnotificationtype/)

DELETE

[/types/{notificationId}](/docs/api-reference/operations/types_deletenotificationtype/)

PATCH

[/types/{notificationId}](/docs/api-reference/operations/types_updatenotificationtype/)

GET

[/users/{userId}](/docs/api-reference/operations/user_getuser/)

POST

[/users/{userId}](/docs/api-reference/operations/user_identify/)

GET

[/users/account-metadata](/docs/api-reference/operations/user_getaccountmetadata/)

DELETE

[/user\_suppression/{userId}/channel/{channel}](/docs/api-reference/operations/users_removeuserfromsuppression/)

GET

[/users](/docs/api-reference/operations/users_listusers/)

DELETE

[/users/{userId}](/docs/api-reference/operations/users_deleteuser/)

POST

[/voice/browser-call](/docs/api-reference/operations/voice_createbrowsercall/)

POST

[/voice/call](/docs/api-reference/operations/voice_call/)

GET

[/voice/calls](/docs/api-reference/operations/voice_listcalls/)

GET

[/voice/calls/{trackingId}](/docs/api-reference/operations/voice_getcall/)

POST

[/voice/calls/{trackingId}/transfer](/docs/api-reference/operations/voice_transfer/)

POST

[/voice/inbound-claims](/docs/api-reference/operations/voice_arminboundclaim/)

PUT

[/voice/numbers/{phoneNumber}/inbound](/docs/api-reference/operations/voice_putnumberinbound/)

DELETE

[/voice/numbers/{phoneNumber}/inbound](/docs/api-reference/operations/voice_clearnumberinbound/)

GET

[/webhooks](/docs/api-reference/operations/webhooks_listwebhooks/)

POST

[/webhooks](/docs/api-reference/operations/webhooks_createwebhook/)

PUT

[/webhooks/{endpointId}](/docs/api-reference/operations/webhooks_updatewebhook/)

DELETE

[/webhooks/{endpointId}](/docs/api-reference/operations/webhooks_deletewebhook/)

POST

[/send](/docs/api-reference/operations/send/)

## Authentication

### apiKey

API Key authentication using Bearer token for server-side projects

**Security scheme type:** http

**Bearer format:** JWT

### clientCredentials

Client credentials authentication using clientId:clientSecret (Basic)

**Security scheme type:** http

### endUser

End-user authentication using clientId:userId (Basic)

**Security scheme type:** http

### endUserHashed

End-user authentication using clientId:userId:hashedUserId (Basic)

**Security scheme type:** http

[Next  
account\_getAccountDetails](/docs/api-reference/operations/account_getaccountdetails/)
