Skip to content

Customer

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

Request user count information 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
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, <= 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 HEAD \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/44444?activation=false&access=false&failover=false&group=group%3Demea%26group%3Dgermany'

Responses

OK

Headers
User-Countinteger, >= 0required

The number of users belonging to the customer

Response
No content