notifications

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

Change this phone's name, language, time zone or quiet hours.

All notifications endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PATCH https://api.zinndigital.com/v1/me/push-devices/{device_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Quiet hours are minutes after local midnight in the phone's time_zone. A window may cross midnight (22:00 to 07:00 is quiet_start=1320, quiet_end=420); equal start and end is an EMPTY window, never all day. During quiet hours an alert to this phone is skipped and recorded as skipped in the delivery log; every other destination still receives it.

Parameters

NameTypeRequiredWhat it is
device_id (path)stringYes—
org_id (query)stringNo—

Request body

NameTypeRequiredWhat it is
device_namestringNo—
localestringNo—
time_zonestringNo—
quiet_enabledbooleanNo—
quiet_startintegerNo—
quiet_endintegerNo—

Response

NameTypeRequiredWhat it is
idstringYes—
connection_idstringYes—
installation_idstringYes—
platformstring<ios, android>Yes—
device_namestringNo—
os_versionstringNo—
app_versionstringNo—
localestringNo—
time_zonestringNo—
quiet_enabledbooleanYes—
quiet_startintegerYes—
quiet_endintegerYes—
healthstringYes—
last_delivery_atstringNo—
last_seen_atstringYes—
created_atstringYes—

Errors this endpoint can return

401 · 403 · 404