Skip to content

Overview

Pingram 1.0.0

Internal API for notification delivery and management

Information

  • OpenAPI version: 3.0.0

Operations

GET
/account
POST
/account
GET
/account/organization
DELETE
/account/supabase
POST
/account/supabase/configure
POST
/account/supabase/oauth
GET
/account/supabase/projects
GET
/account/supabase/status
POST
/billing
GET
/addresses
POST
/addresses
PATCH
/addresses
DELETE
/addresses/{fullAddress}
GET
/components
POST
/components
GET
/components/{componentId}
DELETE
/components/{componentId}
PATCH
/components/{componentId}
GET
/components/public
GET
/domains
POST
/domains
DELETE
/domains/{sender}
POST
/domains/{sender}/start-verification
POST
/editor/token
POST
/email
GET
/environments
POST
/environments
PATCH
/environments/{clientId}
GET
/status
POST
/insights
GET
/keys
POST
/keys
DELETE
/keys/{keyId}
GET
/logs
GET
/logs/{trackingIds}
POST
/logs/query
GET
/logs/query/{queryId}
GET
/logs/retention
GET
/logs/tail
GET
/members
POST
/members
DELETE
/members/{userId}
PATCH
/members/{userId}
GET
/members/autojoin
POST
/members/autojoin
DELETE
/numbers/{phoneNumber}
GET
/numbers/available
GET
/numbers/list
POST
/numbers/order
GET
/numbers/released
GET
/organization/usage
GET
/organization/usage/history
POST
/organizations
POST
/profile/accept_invite
POST
/profile/change-email
POST
/profile/delete-account
GET
/profile/mfa
POST
/profile/mfa
DELETE
/profile/mfa/{type}
POST
/profile/mfa/verify
GET
/settings/push/apn
PUT
/settings/push/apn
DELETE
/settings/push/apn
GET
/settings/push/fcm
PUT
/settings/push/fcm
DELETE
/settings/push/fcm
PUT
/sender/scheduler/{trackingId}
DELETE
/sender/scheduler/{trackingId}
POST
/sender/test/email
POST
/sms
GET
/notifications/{notificationId}/{channel}/templates
POST
/notifications/{notificationId}/{channel}/templates
GET
/notifications/{notificationId}/{channel}/templates/{templateId}
DELETE
/notifications/{notificationId}/{channel}/templates/{templateId}
PATCH
/notifications/{notificationId}/{channel}/templates/{templateId}
PATCH
/notifications/{notificationId}/{channel}/templates/default-selection
GET
/types
POST
/types
GET
/types/{notificationId}
DELETE
/types/{notificationId}
PATCH
/types/{notificationId}
GET
/user/inapp
PATCH
/user/inapp
GET
/user/inapp/unread
PATCH
/user/inapp/unread
GET
/users/{userId}
POST
/users/{userId}
GET
/users/{userId}/slack-channels
POST
/users/{userId}/slack-oauth
GET
/users/account-metadata
DELETE
/user_suppression/{userId}/channel/{channel}
GET
/users
DELETE
/users/{userId}
GET
/webhooks/events
PUT
/webhooks/events
DELETE
/webhooks/events
POST
/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