Skip to content

Register Push Notification Token

This endpoint is to be used by the QHS app. When registering the user's device in Firebase for push notifications, a token will be returned to the app. It will then send that token to this endpoint, to be registered for the logged-in user.

Request

POST /users/{user-uuid}/push-notification-registrations
  • user-uuid is a 22-character identifier for the user

Authorization

Authorization header is required for this endpoint. See Authorization Tokens for details about auth tokens.

Headers

N/A

Query Parameters N/A

Body

The body of the request is expected to contain the registration token in this format:

{
    "registrationToken": "<registration-token-from-firebase>"
}

Response

Response Status Code More Information
Success 200 If the operation was successful
Not Found 404 Survey or item does not exist with the provided UUID
Unauthorized 401 If user is not authorized for the requested survey
Internal Server Error 500 Unknown error

Headers

N/A

Body

N/A