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

Request user information

Request

Path
CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required
Example: 44444
USERstring[^/]+(?:@|%40)[^/]+required
Example: customer@domain.com
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/{CUSTOMER}/{USER}'

Responses

OK

Bodyapplication/json
idstringrequired
timestampstringrequired
userobjectrequired
user.​customerstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required
Example: "44444"
user.​domainstring(domain_v2)<= 128 characters([a-zA-Z0-9]+[-]+)*[a-zA-Z0-9]+\.(([a-zA-Z0-9...required
Example: "domain.com"
user.​userstring(user_v2)<= 256 characters^([!#$%&'*+/=?^_`{|}~a-zA-Z0-9-]+\.)*[!#$%&'*...required
Example: "customer@domain.com"
user.​displayNamestring(displayName)[ 1 .. 256 ] charactersrequired
Example: "R. Meyer"
user.​givenNamestring(givenName)[ 1 .. 128 ] charactersrequired
Example: "Robert"
user.​surNamestring(surName)[ 1 .. 128 ] charactersrequired
Example: "Meyer"
user.​languagestring(language)<= 8 charactersrequired
Enum"cs_CZ""da_DK""de_DE""en_GB""en_US""es_ES""es_MX""fi_FI""fr_FR""hu_HU"
Example: "de_DE"
user.​timezonestring(timezone)<= 32 charactersrequired
Enum"Africa/Abidjan""Africa/Accra""Africa/Addis_Ababa""Africa/Algiers""Africa/Asmara""Africa/Asmera""Africa/Bamako""Africa/Bangui""Africa/Banjul""Africa/Bissau"
Example: "Europe/Berlin"
user.​departmentstring or null(department_v2)[ 1 .. 256 ] characters
Example: "Sales"
user.​costcenterstring or null(costcenter_v2)[ 1 .. 256 ] characters
Example: "01"
user.​phonestring or null(phone)[ 1 .. 64 ] characters
Example: "+49 30 67242-33"
user.​mobilestring or null(mobile)[ 1 .. 64 ] characters
Example: "+49 175 424222"
user.​failoverGroupsArray of strings or null(failoverGroups)<= 16 items
Example: ["emea","germany"]
user.​statusobjectrequired
user.​status.​activationbooleanrequired
user.​status.​accessbooleanrequired
user.​status.​failoverbooleanrequired
Response
application/json
{
  "id": "string",
  "timestamp": "string",
  "user": {
    "customer": "44444",
    "domain": "domain.com",
    "user": "customer@domain.com",
    "displayName": "R. Meyer",
    "givenName": "Robert",
    "surName": "Meyer",
    "language": "de_DE",
    "timezone": "Europe/Berlin",
    "department": "Sales",
    "costcenter": "01",
    "phone": "+49 30 67242-33",
    "mobile": "+49 175 424222",
    "failoverGroups": [ … ],
    "status": { … }
  }
}

Create new user

Request

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
Bodyapplication/jsonrequired
displayNamestring(displayName)[ 1 .. 256 ] charactersrequired
Example: "R. Meyer"
givenNamestring(givenName)[ 1 .. 128 ] charactersrequired
Example: "Robert"
surNamestring(surName)[ 1 .. 128 ] charactersrequired
Example: "Meyer"
languagestring(language)<= 8 characters
Enum"cs_CZ""da_DK""de_DE""en_GB""en_US""es_ES""es_MX""fi_FI""fr_FR""hu_HU"
Example: "de_DE"
timezonestring(timezone)<= 32 characters
Enum"Africa/Abidjan""Africa/Accra""Africa/Addis_Ababa""Africa/Algiers""Africa/Asmara""Africa/Asmera""Africa/Bamako""Africa/Bangui""Africa/Banjul""Africa/Bissau"
Example: "Europe/Berlin"
departmentstring or null(department_v2)[ 1 .. 256 ] characters
Example: "Sales"
costcenterstring or null(costcenter_v2)[ 1 .. 256 ] characters
Example: "01"
phonestring or null(phone)[ 1 .. 64 ] characters
Example: "+49 30 67242-33"
mobilestring or null(mobile)[ 1 .. 64 ] characters
Example: "+49 175 424222"
failoverGroupsArray of strings or null(failoverGroups)<= 16 items
Example: ["emea","germany"]
curl -i -X PUT \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/{CUSTOMER}/{USER}?mailNotification=true' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "R. Meyer",
    "givenName": "Robert",
    "surName": "Meyer",
    "language": "de_DE",
    "timezone": "Europe/Berlin",
    "department": "Sales",
    "costcenter": "01",
    "phone": "+49 30 67242-33",
    "mobile": "+49 175 424222",
    "failoverGroups": [
      "emea",
      "germany"
    ]
  }'

Responses

OK

Bodyapplication/json
idstringrequired
timestampstringrequired
Response
application/json
{
  "id": "string",
  "timestamp": "string"
}

Update existing user

Request

Path
CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required
Example: 44444
USERstring[^/]+(?:@|%40)[^/]+required
Example: customer@domain.com
Bodyapplication/jsonrequired
non-empty
displayNamestring(displayName)[ 1 .. 256 ] characters
Example: "R. Meyer"
givenNamestring(givenName)[ 1 .. 128 ] characters
Example: "Robert"
surNamestring(surName)[ 1 .. 128 ] characters
Example: "Meyer"
languagestring(language)<= 8 characters
Enum"cs_CZ""da_DK""de_DE""en_GB""en_US""es_ES""es_MX""fi_FI""fr_FR""hu_HU"
Example: "de_DE"
timezonestring(timezone)<= 32 characters
Enum"Africa/Abidjan""Africa/Accra""Africa/Addis_Ababa""Africa/Algiers""Africa/Asmara""Africa/Asmera""Africa/Bamako""Africa/Bangui""Africa/Banjul""Africa/Bissau"
Example: "Europe/Berlin"
departmentstring or null(department_v2)[ 1 .. 256 ] characters
Example: "Sales"
costcenterstring or null(costcenter_v2)[ 1 .. 256 ] characters
Example: "01"
phonestring or null(phone)[ 1 .. 64 ] characters
Example: "+49 30 67242-33"
mobilestring or null(mobile)[ 1 .. 64 ] characters
Example: "+49 175 424222"
failoverGroupsArray of strings or null(failoverGroups)<= 16 items
Example: ["emea","germany"]
curl -i -X PATCH \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/{CUSTOMER}/{USER}' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "R. Meyer",
    "givenName": "Robert",
    "surName": "Meyer",
    "language": "de_DE",
    "timezone": "Europe/Berlin",
    "department": "Sales",
    "costcenter": "01",
    "phone": "+49 30 67242-33",
    "mobile": "+49 175 424222",
    "failoverGroups": [
      "emea",
      "germany"
    ]
  }'

Responses

OK

Bodyapplication/json
idstringrequired
timestampstringrequired
Response
application/json
{
  "id": "string",
  "timestamp": "string"
}

Delete existing user

Request

Path
CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required
Example: 44444
USERstring[^/]+(?:@|%40)[^/]+required
Example: customer@domain.com
curl -i -X DELETE \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/{CUSTOMER}/{USER}'

Responses

OK

Bodyapplication/json
idstringrequired
timestampstringrequired
Response
application/json
{
  "id": "string",
  "timestamp": "string"
}

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

Password

Update user password using a security token

Operations