OneSignal
Push notifications and messaging platform
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.onesignal.com/ | link | — | — | — |
Actions (46)
Users · 10
- Create or update aliasPATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
Add or update one or more user aliases (identities).
documented - Create or update aliasPATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
Upsert identity aliases for a user.
documented - Create subscription by aliasPOST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions
Attach a new subscription to an existing user identified by an alias.
documented - Create userPOST /apps/{app_id}/users
Create a new user or modify subscriptions for an existing User.
documented - Delete aliasDELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}
Remove a specific alias from a user.
documented - Delete userDELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}
Permanently delete a user and all data.
documented - Update userPATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}
Update a user's properties and subscriptions.
documented - View identity by subscriptionGET /apps/{app_id}/subscriptions/{subscription_id}/user/identity
Retrieve all aliases for a user using a known subscription.
documented - View userGET /apps/{app_id}/users/by/{alias_label}/{alias_id}
Retrieve a user by a known alias.
documented - View user identityGET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
Retrieve all aliases for a user identified by an alias.
documented
Apps & Keys · 8
- Create API keyPOST /apps/{app_id}/auth/tokens
Create an API key for the app.
documented - Create appPOST /apps
Create a new OneSignal app.
documented - Delete API keyDELETE /apps/{app_id}/auth/tokens/{token_id}
Delete an API key.
documented - List API keysGET /apps/{app_id}/auth/tokens
List API keys for the app.
documented - List appsGET /apps
List all OneSignal apps under the account.
documented - Update API keyPATCH /apps/{app_id}/auth/tokens/{token_id}
Update an API key.
documented - Update appPATCH /apps/{app_id}
Update app settings.
documented - View appGET /apps/{app_id}
Get app metadata and platform configuration.
documented
Messages · 7
- Cancel messageDELETE /notifications/{message_id}?app_id={app_id}
Stop a scheduled or currently outgoing message.
documented - Create SMSPOST /notifications?c=sms
Create and deliver an SMS notification.
documented - Create emailPOST /notifications?c=email
Create and deliver an email notification.
documented - Create push notificationPOST /notifications?c=push
Create and deliver a push notification to targeted devices.
documented - Message history exportPOST /notifications/{message_id}/history
Request a per-message delivery/recipient history export.
documented - View messageGET /notifications/{message_id}?app_id={app_id}
Fetch details for a single message and its outcomes.
documented - View messagesGET /notifications?app_id={app_id}&limit={limit}&offset={offset}&kind={kind}&template_id={template_id}&time_offset={time_offset}
List messages for an app with optional pagination and filters.
documented
Subscriptions · 6
- Create subscription by aliasPOST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions
Attach a new subscription to an existing user identified by an alias.
documented - Delete subscriptionDELETE /apps/{app_id}/subscriptions/{subscription_id}
Delete a specific subscription.
documented - Transfer subscriptionPATCH /apps/{app_id}/subscriptions/{subscription_id}/owner
Transfer a subscription to a different user within the app.
documented - Transfer subscriptionPATCH /apps/{app_id}/subscriptions/{subscription_id}/owner
Transfer a subscription to a different user within the app.
documented - Update subscription by IDPATCH /apps/{app_id}/subscriptions/{subscription_id}
Update an existing subscription by its ID.
documented - Update subscription by tokenPATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token}
Update a subscription identified by its token.
documented
Templates · 6
- Copy template to another appPOST /templates/{template_id}/copy_to_app
Copy a template to a different OneSignal app.
documented - Create templatePOST /templates
Create a reusable template for push, email, or SMS messages.
documented - Delete templateDELETE /templates/{template_id}
Remove a template.
documented - List templatesGET /templates
View all templates for the app.
documented - Update templatePATCH /templates/{template_id}
Update an existing template.
documented - View templateGET /templates/{template_id}
Retrieve a single template.
documented
Segments · 4
- Create segmentPOST /apps/{app_id}/segments
Create a segment with defined filters.
documented - Delete segmentDELETE /apps/{app_id}/segments/{segment_id}
Delete a segment.
documented - List segmentsGET /apps/{app_id}/segments
List segments for the app.
documented - View segmentGET /apps/{app_id}/segments/{segment_id}
Retrieve a segment's details.
documented
Analytics · 3
- Export audience activity CSVPOST /notifications/{message_id}/export_events
Export event-level data (sent, delivered, clicked, etc.) for a specific message.
documented - Export audience activity CSVPOST /notifications/{message_id}/export_events
Export events (sent/delivered/clicked) for a message.
documented - Export subscriptions CSVPOST /players/csv_export
Request a CSV export of subscriptions for an app.
documented