Remove push token

Overview

Removes the push token registered for the access token used in the call. The device stops receiving push notifications for this session. Other sessions of the same account are not affected.

The call is idempotent: it answers 200 even when no push token was registered.

Controller: App\Http\Controllers\Api\V1\Profile\PushTokenController::destroy()
Route name: api.v1.profile.push-token.destroy

Authentication

Type: Bearer Token
Header: Authorization: Bearer {token}

Request

Method: DELETE
Path: /api/v1/profile/push-token

No parameters and no body.

Example request

Response `200 OK`

{
  "success": true,
  "status": "success",
  "message": "Push token removed"
}

No data key.

Errors

`401 Unauthorized`

Standard shape. message is one of Unauthenticated, Invalid token, Token expired.

`403 Forbidden`

The account is suspended. Every token of the account is revoked at the same time.

{
  "success": false,
  "status": "error",
  "message": "Account suspended"
}

Notes

Only the registration of the current access token is removed.

Logging out, resetting the password, revoking the access token, suspending the account and expiry pruning delete the registration automatically, so this call is not needed before a logout.

See PUT /api/v1/profile/push-token for the registration rules and the push payload data.type values.

Source: docs/api/profile/DELETE_push_token.md

Remove push token

Overview#

Authentication#

Request#

Example request#

Response 200 OK#

Errors#

401 Unauthorized#

403 Forbidden#

Notes#

Request

Responses

Overview

Authentication

Request

Example request

Response `200 OK`

Errors

`401 Unauthorized`

`403 Forbidden`

Notes