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

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

Request user count information for all users belonging to the {CUSTOMER} specified in the URL path

Request

Path

CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required

Example: 44444

Query

activationboolean

Filters response according to state of activation flag

Example: activation=false

accessboolean

Filters response according to state of access flag

Example: access=false

failoverboolean

Filters response according to state of failover flag

Example: failover=false

groupArray of strings or null(failoverGroups)<= 16 items

Restricts the operation to users who are a member of at least one of the given failover groups. If this parameter is absent, the operation will be applied to all users of the customer {CUSTOMER}.

Example: group=group=emea&group=germany

curl -i -X HEAD \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/{CUSTOMER}?access=false&activation=false&failover=false&group=emea%2Cgermany'

Responses

Headers

User-Countinteger>= 0required

The number of users belonging to the customer

Response

application/json

{
  "id": "string",
  "timestamp": "string",
  "status": 403,
  "message": "Forbidden"
}

Request user information for all users belonging to the {CUSTOMER} specified in the URL path

Request

Path

CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required

Example: 44444

Query

activationboolean

Filters response according to state of activation flag

Example: activation=false

accessboolean

Filters response according to state of access flag

Example: access=false

failoverboolean

Filters response according to state of failover flag

Example: failover=false

offsetinteger>= 0

Offset used for pagination

Default 0

sizeinteger>= 0

Limits size of response

Default 1000

groupArray of strings or null(failoverGroups)<= 16 items

Restricts the operation to users who are a member of at least one of the given failover groups. If this parameter is absent, the operation will be applied to all users of the customer {CUSTOMER}.

Example: group=group=emea&group=germany

curl -i -X GET \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/{CUSTOMER}?access=false&activation=false&failover=false&group=emea%2Cgermany&offset=0&size=1000'

Responses

Bodyapplication/json

idstringrequired

timestampstringrequired

offsetinteger>= 0required

sizeinteger>= 0required

filterobjectrequired

filter.activationbooleanrequired

filter.accessbooleanrequired

filter.failoverbooleanrequired

totalinteger>= 0required

countinteger>= 0required

usersArray of objectsrequired

users[].customerstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required

Example: "44444"

users[].domainstring(domain_v2)<= 128 characters([a-zA-Z0-9]+[-]+)*[a-zA-Z0-9]+\.(([a-zA-Z0-9...required

Example: "domain.com"

users[].userstring(user_v2)<= 256 characters^([!#$%&'*+/=?^_`{|}~a-zA-Z0-9-]+\.)*[!#$%&'*...required

Example: "customer@domain.com"

users[].displayNamestring(displayName)[ 1 .. 256 ] charactersrequired

Example: "R. Meyer"

users[].givenNamestring(givenName)[ 1 .. 128 ] charactersrequired

Example: "Robert"

users[].surNamestring(surName)[ 1 .. 128 ] charactersrequired

Example: "Meyer"

users[].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"

users[].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"

users[].departmentstring or null(department_v2)[ 1 .. 256 ] characters

Example: "Sales"

users[].costcenterstring or null(costcenter_v2)[ 1 .. 256 ] characters

Example: "01"

users[].phonestring or null(phone)[ 1 .. 64 ] characters

Example: "+49 30 67242-33"

users[].mobilestring or null(mobile)[ 1 .. 64 ] characters

Example: "+49 175 424222"

users[].failoverGroupsArray of strings or null(failoverGroups)<= 16 items

Example: ["emea","germany"]

users[].statusobjectrequired

users[].status.activationbooleanrequired

users[].status.accessbooleanrequired

users[].status.failoverbooleanrequired

Response

application/json

{
  "id": "string",
  "timestamp": "string",
  "offset": 0,
  "size": 0,
  "filter": {
    "activation": true,
    "access": true,
    "failover": true
  },
  "total": 0,
  "count": 0,
  "users": [
    { … }
  ]
}

Create several users belonging to the {CUSTOMER} specified in the URL path

Request

Path

CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required

Example: 44444

Query

mailNotificationstring

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

Example: mailNotification=true

Bodyapplication/jsonrequiredArray [

userstring(user_v2)<= 256 characters^([!#$%&'*+/=?^_`{|}~a-zA-Z0-9-]+\.)*[!#$%&'*...required

Example: "customer@domain.com"

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}?mailNotification=true' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "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": [
        "emea",
        "germany"
      ]
    }
  ]'

Responses

Bodyapplication/json

idstringrequired

timestampstringrequired

countinteger>= 0required

usersArray of strings(user_v2)required

Example: ["customer@domain.com"]

Response

application/json

{
  "id": "string",
  "timestamp": "string",
  "count": 0,
  "users": [
    "customer@domain.com"
  ]
}

Update existing users belonging to the {CUSTOMER} specified in the URL path

Request

Path

CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required

Example: 44444

Bodyapplication/jsonrequiredArray [

userstring(user_v2)<= 256 characters^([!#$%&'*+/=?^_`{|}~a-zA-Z0-9-]+\.)*[!#$%&'*...required

Example: "customer@domain.com"

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}' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "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": [
        "emea",
        "germany"
      ]
    }
  ]'

Responses

Bodyapplication/json

idstringrequired

timestampstringrequired

countinteger>= 0required

usersArray of strings(user_v2)required

Example: ["customer@domain.com"]

Response

application/json

{
  "id": "string",
  "timestamp": "string",
  "count": 0,
  "users": [
    "customer@domain.com"
  ]
}

Delete existing users

Request

Path

CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required

Example: 44444

Bodyapplication/jsonrequiredArray [

string(user_v2)<= 256 characters^([!#$%&'*+/=?^_`{|}~a-zA-Z0-9-]+\.)*[!#$%&'*...

]

curl -i -X DELETE \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/{CUSTOMER}' \
  -H 'Content-Type: application/json' \
  -d '[
    "customer@domain.com"
  ]'

Responses

Bodyapplication/json

idstringrequired

timestampstringrequired

countinteger>= 0required

usersArray of strings(user_v2)required

Example: ["customer@domain.com"]

Response

application/json

{
  "id": "string",
  "timestamp": "string",
  "count": 0,
  "users": [
    "customer@domain.com"
  ]
}

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

Password

Update user password using a security token

Operations

Continuity-Service

Customer

Request user count information for all users belonging to the {CUSTOMER} specified in the URL path

Request

Responses

Was this helpful?

Request user information for all users belonging to the {CUSTOMER} specified in the URL path

Request

Responses

Was this helpful?

Create several users belonging to the {CUSTOMER} specified in the URL path

Request

Responses

Was this helpful?

Update existing users belonging to the {CUSTOMER} specified in the URL path

Request

Responses

Was this helpful?

Delete existing users

Request

Responses

Was this helpful?

Customer Flag

User

User Flag

Token

Password