Continuity-Service

REST service to maintain Retarus Email Continuity mailboxes and control failover routing

Find out more about Retarus Email Continuity
Download OpenAPI description
email-continuity-api.json
email-continuity-api.yaml
Languages
Servers
Mock server

https://developers.retarus.com/_mock/seg/email-continuity-api/

Public Endpoint

https://api.retarus.com/email/continuity/v2/

Customer

Bulk request, update or delete user information for all users belonging to the {CUSTOMER} number specified in the path of a request

Operations

Customer Flag

Update or delete flag for all users belonging to the {CUSTOMER} number specified in the path of a request, e.g. activate the Email Continuity failover or access to the web mailbox for all users

Operations

User

Request, update or delete user information for a single user belonging to the {CUSTOMER} number specified in the path of a request

Operations

User Flag

Update or delete flag for a single user belonging to the {CUSTOMER} number specified in the path of a request, e.g. activate the Email Continuity failover or the access to the web mailbox

Operations

Token

Request a security token required for account activation and password reset

Operations

Create new password token for account activation or password reset. The response contains an URL directing the user to a web frontend where the user can set or reset the password. The URL consists of base part and token. The base part is subject to static configuration and may contain an individual path component for each customer

Request

Security
basicAuth
Path
CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required
Example: 44444
USERstring[^/]+(?:@|%40)[^/]+required
Example: customer@domain.com
Query
mailNotificationstring

If set to true or 1, an email notification is sent to the end user automatically

Example: mailNotification=true
curl -i -X POST \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/44444/customer@domain.com/token?mailNotification=true'

Responses

OK

Bodyapplication/json
idstringrequired
timestampstringrequired
tokenstringrequired
expiryTimestampstringrequired
urlstringrequired
Response
application/json
{
  "id": "string",
  "timestamp": "string",
  "token": "string",
  "expiryTimestamp": "string",
  "url": "string"
}

Password

Update user password using a security token

Operations