WoyraDocs
Get an API key

Rotate a mailbox device session

POST/v1/mail/auth/refresh

Mailboxes · Public: no credential needed

Exchanges a refresh credential for new access and refresh credentials. The device session expires 30 days after sign-in. Reusing a consumed refresh credential revokes that device session. Serialize refresh requests and securely persist each replacement before using it.

Body

FieldTypeDescription
refreshTokenrequiredstring

Example

curl -X POST https://api.woyra.io/v1/mail/auth/refresh \
  -H 'Content-Type: application/json' \
  -d '{
    "refreshToken": "<refreshToken>"
  }'

Response

200 Rotated credentials. Response is not cacheable.

FieldTypeDescription
tokenrequiredstring
mailboxrequiredstring
expiresAtrequiredtimestamp
expiresInrequiredintegerSeconds.
refreshTokenstringOnly for opted-in password device sessions; store securely, never log.
sessionExpiresAttimestampAbsolute expiry of the device session.

Errors

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

Also in Mailboxes