Add an FCM registration token

POST https://mapvoyage.zulipchat.com/api/v1/users/me/android_gcm_reg_id

This endpoint adds an FCM registration token for push notifications.

Changes: Deprecated in Zulip 11.0 (feature level 406). Clients connecting to newer servers and with E2EE push notifications support should use the Register E2EE push device endpoint, as this endpoint will be removed in a future release.

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

request = {"token": "android-token"}
result = client.call_endpoint(
    url="/users/me/android_gcm_reg_id", method="POST", request=request
)
print(result)

curl -sSX POST https://mapvoyage.zulipchat.com/api/v1/users/me/android_gcm_reg_id \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode token=android-token

Parameters

Response

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}

A typical failed JSON response for when the token's length is invalid or is empty:

{
    "code": "BAD_REQUEST",
    "msg": "Empty or invalid length token",
    "result": "error"
}