Skip to content

Commit d85616e

Browse files
committed
chore: updated API.md docs
1 parent 305280e commit d85616e

1 file changed

Lines changed: 72 additions & 0 deletions

File tree

docs/API.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2422,6 +2422,78 @@ POST /users/me/devices
24222422

24232423
- [400 Bad Request] - Possible 'type' values: MISSING_INPUT, INVALID_PLATFORM.
24242424

2425+
## Unregister a device
2426+
2427+
- Endpoint:
2428+
2429+
```
2430+
DELETE /users/me/devices/:deviceToken
2431+
```
2432+
2433+
- Description: Unregisters a mobile device by its token, preventing it from receiving future push notifications.
2434+
- Auth required: Yes
2435+
2436+
### Request parameters:
2437+
2438+
- deviceToken (string, Required): The unique registration token of the device to unregister (passed as a path parameter).
2439+
- Example:
2440+
2441+
```text
2442+
DELETE /users/me/devices/fcm_token_1234567890
2443+
```
2444+
2445+
### Request body:
2446+
2447+
- None
2448+
2449+
### Responses:
2450+
2451+
- [200 OK] - Device unregistered successfully.
2452+
2453+
```json
2454+
{
2455+
"message": "Device unregistered successfully."
2456+
}
2457+
```
2458+
2459+
- [400 Bad Request] - Possible 'type' values: MISSING_INPUT.
2460+
2461+
## Get device notification status
2462+
2463+
- Endpoint:
2464+
2465+
```
2466+
GET /users/me/devices/:deviceToken/status
2467+
```
2468+
2469+
- Description: Checks whether a specific device token is registered for the authenticated user.
2470+
- Auth required: Yes
2471+
2472+
### Request parameters:
2473+
2474+
- deviceToken (string, Required): The unique registration token of the device (passed as a path parameter).
2475+
- Example:
2476+
2477+
```text
2478+
GET /users/me/devices/fcm_token_1234567890/status
2479+
```
2480+
2481+
### Request body:
2482+
2483+
- None
2484+
2485+
### Responses:
2486+
2487+
- [200 OK] - Device status retrieved successfully.
2488+
2489+
```json
2490+
{
2491+
"is_enabled": true
2492+
}
2493+
```
2494+
2495+
- [400 Bad Request] - Possible 'type' values: MISSING_INPUT.
2496+
24252497
## Get user's public profile
24262498

24272499
- Endpoint:

0 commit comments

Comments
 (0)