Download OpenAPI specification:Download
Documentation of the Open-Xchange Cloud-Plugins Rest APIs.
change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| custom | string 1 items |
{- "custom": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| msisdn | string 1 items |
{- "msisdn": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}get uidname of user
| search required | string string to search for |
| field | string Enum: "UIDNAME" "MSISDN" "CUSTOM" "ANY" field to search into |
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}change user data
| contextid required | number context id |
| userid required | number user id |
put parameters
| uidname | string 1 items |
{- "uidname": "string"
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}change user data
| contextid required | number context id |
| userid required | number user id |
post parameters
| msisdn | string >= 0 items |
| custom | Array of strings >= 0 items |
{- "msisdn": "+49.12345.6789",
- "custom": [
- "id 1",
- "id 2"
]
}{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}get all data in one request
| uid required | string user identifier |
{- "recentmails": [
- {
- "id": "string",
- "subject": "string",
- "from": "string",
- "seen": true,
- "arrival": 0
}
], - "quota": {
- "mailQuota": {
- "usedQuota": 0,
- "maxQuota": 0
}
}, - "newmessages": {
- "newmessages": 0
}, - "recentmessages": {
- "newmessages": 0
}
}get 5 recent mails from user
| uid required | string user identifier |
[- {
- "id": "string",
- "subject": "string",
- "from": "string",
- "seen": true,
- "arrival": 0
}
]Get the filtered blacklist for user
| contextId required | number context id |
| userid required | number user id |
| filter required | string the blacklist filter which can contain wildcard * |
{- "blacklist": [
- "test@example.com",
- "test2@example.com",
- "@example.com"
]
}Get the filtered whitelist for user
| contextId required | number context id |
| userid required | number user id |
| filter required | string the whitelist filter which can contain wildcard * |
{- "whitelist": [
- "test@example.com",
- "test2@example.com",
- "@example.com"
]
}Send an "over quota" mail to user
| usercontext required | string the user context and user id in the form "userid@contextid" |
the user quota threshold
| quota_threshold | number |
{- "quota_threshold": 1000
}{- "mail": "the message content"
}Send an "over quota" mail to user
| usercontext required | string the user context and user id in the form "userid@contextid" |
the user quota threshold
| quota_threshold | number |
{- "quota_threshold": 1000
}{- "mail": "the message content"
}Send a "disabled send from sending spam" mail to user
| usercontext required | string the user context and user id in the form "userid@contextid" |
3@4 has no primary mail address
Send a "welcome" mail to user
| usercontext required | string the user context and user id in the form "userid@contextid" |
{- "mail": "the message content"
}