Push Tokens

Register push token

Register a new push token or refresh an existing one (upsert). If a token with the same (alias, platform, token) combination already exists, its expiry is extended and failure count is reset. Tokens are automatically pruned after 90 days of inactivity or 3 consecutive delivery failures.

post/v1/push-tokens

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/push-tokens
  • Auth: one of:
    • HTTP basic
    • HTTP basic

Request body

platform'apns' | 'fcm' | 'unified-push' | 'web-push' required

Push notification platform

tokenstring required

Device token (APNs hex), registration token (FCM), or a JSON push subscription with endpoint and keys (UnifiedPush and Web Push). Web Push endpoints must belong to a browser push service (Firebase Cloud Messaging, Mozilla, Apple or Windows); UnifiedPush endpoints must use HTTPS on port 443 or on port 1024 and above.

device_namestring

Optional human-readable device name for management

alias_idstring

Required when using API token authentication. The alias ID to register the token for.

Response

Push token registered successfully

idstring

Unique push token document ID

aliasstring

Alias ID this token belongs to

platform'apns' | 'fcm' | 'unified-push' | 'web-push'

Push notification platform

tokenstring

Device token, registration token, or push endpoint URL

device_namestring

Optional human-readable device name

last_used_atstring date-time nullable

Last successful push delivery timestamp

failure_countinteger

Consecutive delivery failure count (auto-pruned at 3)

expires_atstring date-time

Token expiry (auto-extended on successful delivery)

created_atstring date-time

Registration timestamp

updated_atstring date-time

Last update timestamp

object'push_token'

Object type identifier

Changes

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