Push

The devices that receive push notifications.4 operations

Headers on every response

Every response on this page carries these headers.
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).

Operations

PUT/api/v1/me/devices

Register this phone's push token for the signed-in login

Idempotent per token: a token already known is marked seen and handed to the caller's login — a reinstall, or a new login on the same phone — never duplicated (#198). platform is ios or android; provider defaults to expo. A device belongs to the person, not to a household.

Parameters

No parameters

Request body

application/jsonRequiredRegisterPushDeviceRequest

Responses

200OK
application/jsonPushDeviceResponse
400Bad Request
application/problem+jsonProblemDetails
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X PUT \
  "https://bryti.app/api/v1/me/devices" \
  -H "Content-Type: application/json" \
  -d '{"token":"string","platform":"string","provider":"string"}'

Example response

200application/json
{
  "token": "string",
  "platform": "string",
  "provider": "string",
  "listChanges": false,
  "householdNews": false,
  "runDone": false,
  "reminders": false,
  "lastSeenAt": "2026-09-07T16:30:00Z",
  "dinnerReminders": "string"
}
GET/api/v1/me/devices/{token}

Read a registered phone and its notification switches

404 when the token is not registered to the caller's login.

Parameters

NameInTypeRequiredDescription
tokenpathstringRequired—

Responses

200OK
application/jsonPushDeviceResponse
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
404Not Found
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  "https://bryti.app/api/v1/me/devices/string"

Example response

200application/json
{
  "token": "string",
  "platform": "string",
  "provider": "string",
  "listChanges": false,
  "householdNews": false,
  "runDone": false,
  "reminders": false,
  "lastSeenAt": "2026-09-07T16:30:00Z",
  "dinnerReminders": "string"
}
PATCH/api/v1/me/devices/{token}

Set which notifications reach this phone

listChanges, householdNews, runDone and reminders. reminders left out keeps its current value, so an older app's three-switch PATCH does not turn Bryti's nudges off behind the person's back (#385). 404 when the token is not the caller's.

Parameters

NameInTypeRequiredDescription
tokenpathstringRequired—

Request body

application/jsonRequiredUpdatePushDeviceRequest

Responses

200OK
application/jsonPushDeviceResponse
400The request could not be read as the route needs it: a body that is not the documented shape (a required field left out, a null where none is allowed, a value too long for its field), a parameter that does not parse, or a NUL character anywhere (#3540, #3541, #3543). Code validation_failed or value_too_long.
application/problem+jsonProblemDetails
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
404Not Found
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X PATCH \
  "https://bryti.app/api/v1/me/devices/string" \
  -H "Content-Type: application/json" \
  -d '{"listChanges":false,"householdNews":false,"runDone":false}'

Example response

200application/json
{
  "token": "string",
  "platform": "string",
  "provider": "string",
  "listChanges": false,
  "householdNews": false,
  "runDone": false,
  "reminders": false,
  "lastSeenAt": "2026-09-07T16:30:00Z",
  "dinnerReminders": "string"
}
DELETE/api/v1/me/devices/{token}

Forget this phone: nothing more is sent to it

Sign-out on the phone. 404 when the token is not the caller's.

Parameters

NameInTypeRequiredDescription
tokenpathstringRequired—

Responses

204No Content
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
404Not Found
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X DELETE \
  "https://bryti.app/api/v1/me/devices/string"

Schemas

ProblemDetails

PropertyTypeRequired
typestring | null—
titlestring | null—
statusinteger (int32) | null—
detailstring | null—
instancestring | null—
codestring | null—

PushDeviceResponse

PropertyTypeRequired
tokenstringRequired
platformstringRequired
providerstringRequired
listChangesbooleanRequired
householdNewsbooleanRequired
runDonebooleanRequired
remindersbooleanRequired
lastSeenAtstring (date-time)Required
dinnerRemindersstringRequired

RegisterPushDeviceRequest

PropertyTypeRequired
tokenstringRequired
platformstringRequired
providerstring | nullRequired
dinnerRemindersstring | null—

UpdatePushDeviceRequest

PropertyTypeRequired
listChangesbooleanRequired
householdNewsbooleanRequired
runDonebooleanRequired
remindersboolean | null—