Skip to content

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

Set flag for all users belonging to the {CUSTOMER} specified in the URL path

Request

Security
basicAuth
Path
CUSTOMERstring, [ 5 .. 7 ] characters(customer)[0-9]{5}([A-Z]{2})?required
Example:44444
FLAGstringrequired
Enum:"failover""access"
Query
groupArray of strings or null, <= 16 items(failoverGroups)

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 PUT \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/44444/{FLAG}?group=group%3Demea%26group%3Dgermany'

Responses

OK

Bodyapplication/json
idstringrequired
timestampstringrequired
affectedUsersinteger, >= 0required
Response
{
  "id": "string",
  "timestamp": "string",
  "affectedUsers": 0
}