---
title: "Register or refresh a native APNs device"
method: POST
path: "/api/v1/me/apns-devices"
tags: ["Account"]
---

# Register or refresh a native APNs device

`POST /api/v1/me/apns-devices`

## Request

- Base URL: `https://spoonjoy.app`
- URL: `https://spoonjoy.app/api/v1/me/apns-devices`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__session`
  - OAuth 2 (authorization code, authorization URL `https://spoonjoy.app/oauth/authorize`, token URL `https://spoonjoy.app/oauth/token`, scopes: `account:write`)

## Headers

- `X-Request-Id` string

## Request body

- ApnsDeviceRegistrationRequest
  - `clientMutationId` string, required
  - `deviceId` string, required
  - `platform` 'ios' | 'ipados' | 'macos', required
  - `environment` 'development' | 'production', required
  - `token` string, required: Raw APNs token. Spoonjoy stores only a hash and returns only tokenPrefix.
  - `deviceName` string, nullable
  - `appVersion` string, nullable

## Response `200`

Success

- ApnsDeviceRegistrationEnvelope
  - `ok` unknown, required
  - `requestId` string, required
  - `data` ApnsDeviceRegistrationData, required
    - `created` boolean, required
    - `device` ApnsDevice, required
      - `id` string, required
      - `deviceId` string, required
      - `platform` 'ios' | 'ipados' | 'macos', required
      - `environment` 'development' | 'production', required
      - `tokenPrefix` string, required: First characters of the APNs token for diagnostics. The full token is never returned.
      - `deviceName` string, nullable, required
      - `appVersion` string, nullable, required
      - `enabledAt` string, date-time, required
      - `revokedAt` string, date-time, nullable, required
      - `lastRegisteredAt` string, date-time, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
    - `mutation` MutationMetadata, required
      - `clientMutationId` string, required
      - `replayed` boolean, required

## Other responses

- `201`: Success
- `400`: Errors: invalid_json, validation_error
- `401`: Errors: authentication_required, invalid_token
- `403`: Errors: insufficient_scope
- `405`: Errors: method_not_allowed
- `409`: Errors: idempotency_conflict, idempotency_in_progress
- `429`: Errors: rate_limited
- `500`: Errors: internal_error
- `503`: Errors: temporarily_unavailable

---

[API](https://skmtc.dev/spoonjoy/apis/spoonjoy-api.md) · [All operations](https://skmtc.dev/spoonjoy/apis/spoonjoy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spoonjoy/apis/spoonjoy-api/revisions/b96eb5d4697d?raw)