Rename or pause an owned device

PATCH

/v1/admin/me/push-devices/{device_id}

• Production
• Local

Clerk identity only. Preferences and devices belong to the person across all current and future organizations. Agent credentials are not accepted. Request bodies are limited to 16 KB. Responses use private, no-store caching.

Authorizations

• ClerkSession
• AgentKey
  account:admin

Parameters

Path Parameters

device_id

required

string

Request Body ^required

object

expected_version

required

integer

>= 1

label

string

<= 80 characters

enabled

boolean

Responses

200

Success

object

id

required

string

endpoint

required

Owner-only endpoint used to identify this browser. Subscription encryption keys are never returned.

string

label

required

string

<= 80 characters

enabled

required

boolean

status

required

string

Allowed values: active expired

version

required

integer

created_ms

required

integer format: int64

updated_ms

required

integer format: int64

last_accepted_ms

required

Push provider acceptance time; does not prove device display.

integer format: int64

400

Invalid bounded request

401

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string

used

Consumed plus reserved units.

integer format: int64

delta

Requested additional units.

integer format: int64

limit

integer format: int64

remaining

integer format: int64

consumed

integer format: int64

reserved

integer format: int64

next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time

upgrade_required

boolean

404

Resource not owned or currently accessible

409

Version conflict

429

Test rate limit exceeded

503

Notification dependency unavailable