Sign in
Users

Register mobile push device

Registers a mobile push device for APNs, Firebase Cloud Messaging, or UnifiedPush. A Web Push registration sends the endpoint URL with encryption_key and auth_secret. A raw registration sends the platform push token with no keys.

post/users/@me/mobile-devices

Request body

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

The mobile push notification platform

tokenstring required

The Web Push endpoint URL when encryption keys are supplied, otherwise the raw platform push token

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 Web Push encryption (base64url)

auth_secretstring

The authentication secret for Web Push encryption (base64url)

Response

Success

device_idstring required

Changes

Changed in 4 of the 21 revisions of this API.3225

  • 1ae25d65c6171See the full diff
    • ○

      added the new ios_apns_voip enum value to the request property

      request-property-enum-value-added

  • a52a2cf49d9b32See the full diff
    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 4dbb738a3e224See the full diff
    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

  • fa36b1b48ca520See the full diff
    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 21 revisions, 2 have no diff computed.