HTTP API reference › Gala Launchpad › Notifications
Gala Launchpad — Notifications
4 operations in this group.
- GET /v1/notifications/preferences — Get notification preferences
- PUT /v1/notifications/preferences — Update notification preferences
- POST /v1/notifications/register — Register push notification device
- DELETE /v1/notifications/unregister — Unregister push notification device
GET /v1/notifications/preferences
NotificationController_getPreferences
Get notification preferences
Get push notification preferences for the authenticated user
Authentication: apiKeyAuth, bearer
api key auth
Responses
200 — Preferences retrieved successfully
Content type: application/json
Schema: NotificationPreferencesSuccessEnvelopeDto
| Field | Type | Required | Description |
|---|---|---|---|
| data | NotificationPreferencesDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
401 — Unauthorized - missing or invalid JWT token or API key
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared authentication and service error envelope.
Content type: application/json
Schema: anyOf: NotificationErrorEnvelopeDto | ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | string | yes | |
| status | integer | yes | |
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example response
[]
PUT /v1/notifications/preferences
NotificationController_updatePreferences
Update notification preferences
Partially update push notification preferences for the authenticated user
Authentication: apiKeyAuth, bearer
api key auth
Request body
Required: yes
application/json
Schema: UpdatePreferencesDto
| Field | Type | Required | Description |
|---|---|---|---|
| chatEnabled | boolean | no | |
| streamsEnabled | boolean | no | |
| systemEnabled | boolean | no | |
| tradesEnabled | boolean | no |
Responses
200 — Preferences updated successfully
Content type: application/json
Schema: NotificationPreferencesSuccessEnvelopeDto
| Field | Type | Required | Description |
|---|---|---|---|
| data | NotificationPreferencesDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
400 — Bad request - invalid preference values
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
401 — Unauthorized - missing or invalid JWT token or API key
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared authentication and service error envelope.
Content type: application/json
Schema: anyOf: NotificationErrorEnvelopeDto | ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | string | yes | |
| status | integer | yes | |
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example request
[]
Example response
[]
POST /v1/notifications/register
NotificationController_registerDevice
Register push notification device
Register or update a push notification token for the authenticated user
Authentication: apiKeyAuth, bearer
api key auth
Request body
Required: yes
application/json
Schema: RegisterDeviceDto
| Field | Type | Required | Description |
|---|---|---|---|
| deviceId | string | no | |
| platform | DevicePlatform | yes | |
| token | string | yes |
Responses
200 — Device registered successfully
Content type: application/json
Schema: RegisterDeviceSuccessEnvelopeDto
| Field | Type | Required | Description |
|---|---|---|---|
| data | RegisteredDeviceDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
400 — Bad request - invalid token or platform
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
401 — Unauthorized - missing or invalid JWT token or API key
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared authentication and service error envelope.
Content type: application/json
Schema: anyOf: NotificationErrorEnvelopeDto | ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | string | yes | |
| status | integer | yes | |
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example request
[]
Example response
[]
DELETE /v1/notifications/unregister
NotificationController_unregisterDevice
Unregister push notification device
Deactivate a push notification token
Authentication: apiKeyAuth, bearer
api key auth
Request body
Required: yes
application/json
Schema: UnregisterDeviceDto
| Field | Type | Required | Description |
|---|---|---|---|
| token | string | yes |
Responses
200 — Device unregistered successfully
Content type: application/json
Schema: UnregisterDeviceSuccessEnvelopeDto
| Field | Type | Required | Description |
|---|---|---|---|
| data | UnregisteredDeviceDto | yes | |
| error | boolean enum: false | yes | |
| message | string | yes | |
| status | number | yes |
400 — Bad request - token not found
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
401 — Unauthorized - missing or invalid JWT token or API key
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared authentication and service error envelope.
Content type: application/json
Schema: anyOf: NotificationErrorEnvelopeDto | ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | string | yes | |
| status | integer | yes | |
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example request
[]
Example response
[]
Previous group: moderator-invites · Next group: overseer-invites