WoyraDocs
Get an API key

Register this native device for mailbox notifications

POST/v1/mail/devices

Mailboxes · Requires an API key

Requires a password-based renewable device-session mailbox token. Ownership comes from that session. Replaces its obsolete token; registration success confirms storage, not notification delivery. Logout and refresh-token replay remove the registered destination.

Body

FieldTypeDescription
tokenrequiredstring
platformrequiredstring
One of ios, android.
soundEnabledbooleanEnable the bundled new-mail sound for this device. System settings can mute it.
mailboxstringMust match the authenticated mailbox if provided.

Example

curl -X POST https://api.woyra.io/v1/mail/devices \
  -H "Authorization: Bearer $WOYRA_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "<token>",
    "platform": "ios"
  }'

Response

204 Device registered.

Errors

StatusCodes
400invalid_request, unsupported_version
401authentication_required, invalid_api_key
429rate_limited, daily_send_limit_reached

Also in Mailboxes