Users

Register mobile push device

Registers a mobile push device token for APNs, Firebase Cloud Messaging, or UnifiedPush. UnifiedPush registrations include the endpoint URL plus Web Push encryption keys.

post/users/@me/mobile-devices

Request body

platform'android_fcm' | 'ios_apns' | 'android_unified_push' required

The mobile push notification platform

tokenstring required

The platform-specific push notification token or endpoint URL

user_agentstring

The user agent string identifying the device

app_idstring

Client app channel or bundle mapping identifier, such as stable, beta, or canary

provider_environment'production' | 'development'

Push provider environment. For APNs, production uses api.push.apple.com and development uses api.sandbox.push.apple.com.

encryption_keystring

The P-256 ECDH public key for UnifiedPush encryption (base64url)

auth_secretstring

The authentication secret for UnifiedPush encryption (base64url)

Response

Success

device_idstring required

The unique identifier for the registered device

Changes

No recorded changes to this endpoint across all 1 revision of this API.