delete_user
Delete User
Permanently delete a user and all associated data by alias.
delete_user
Permanently delete a user and all associated data by alias.
get_user
Retrieve a user's profile, properties, identity, and all subscriptions by alias (external_id or onesignal_id).
create_segment
Create a dynamic audience segment with filter rules. Segments automatically update as users match the criteria. Combine filters with AND/OR operators.
create_app
Create a new OneSignal app under your organization. Requires an Organization API Key. Optionally configure platform-specific push settings.
cancel_notification
Cancel a scheduled or in-progress notification by its ID. Only notifications that have not yet been fully delivered can be cancelled.
delete_template
Delete a message template. Templates used in active Journeys cannot be deleted.
create_subscription
Add a new subscription (push device, email, or SMS) to an existing user. The user is identified by alias.
view_notifications
Retrieve notification details and delivery analytics. Can list recent notifications with pagination or fetch a specific notification by ID with detailed outcome metrics.
update_user
Update a user's properties such as tags, language, timezone, location, and country. Identify the user by alias label and alias ID.
delete_segment
Delete a segment by its ID. System (read-only) segments cannot be deleted.
transfer_subscription
Transfer a subscription from one user to another. Useful when a device changes ownership.
delete_subscription
Remove a subscription (device/email/SMS) from a user permanently.
create_user
Create a new user in OneSignal with optional identity, properties (tags, language, country), and subscriptions (push, email, SMS). If a user with the given external ID already exists, it will be updated.
update_app
Update an existing OneSignal app's settings. Requires an Organization API Key.
create_template
Create a reusable message template for push notifications, emails, or SMS. Templates simplify sending consistent messages across campaigns.
get_app
Retrieve details for a specific OneSignal app by ID. Requires an Organization API Key.
update_subscription
Update an existing subscription's properties such as token, enabled status, or type.
list_segments
Retrieve all segments for the app with pagination support.
get_template
Retrieve the full details of a specific template by its ID.
send_notification
Send a push notification, email, or SMS/MMS message through OneSignal. Supports targeting by segments, user aliases, filters, subscription IDs, email addresses, or phone numbers. Can include rich content like images, action buttons, and custom data.
export_data
Export user and subscription data as a CSV file. Returns a URL to download the gzip-compressed CSV. The file may take some time to generate and is available for 3 days.
update_template
Update an existing template's name, content, or other properties.
list_apps
Retrieve all OneSignal apps under your organization. Requires an Organization API Key.
list_templates
Retrieve all message templates with optional channel filtering and pagination.
Send push notifications, emails, SMS/MMS, and in-app messages through a unified multi-channel messaging API. Create and manage message templates for push, email, and SMS. Target messages to segments, individual users, or specific devices with dynamic personalization and multi-language support. Create, view, update, and delete users and their subscriptions (devices) across platforms. Manage custom data attributes (tags) on users. Create and delete audience segments using filters like activity, country, tags, and message engagement. Export user, subscription, and event data for analytics. View message delivery analytics including open rates and click data. Create, update, and manage apps and API keys programmatically. Configure webhooks for real-time event streaming including notification displayed, clicked, and dismissed events.
Common questions about connecting Onesignal Rest API to AI agents with Metorial.