POST api/users/deleteUsers?customerId={customerId}&countryId={countryId}&defaultPortalId={defaultPortalId}
Remove users
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| customerId |
Customer Id |
integer |
Required |
| countryId | integer |
None. |
|
| defaultPortalId | integer |
None. |
Body Parameters
List of users to delete
| Name | Description | Type | Additional information |
|---|---|---|---|
| DisableWithoutDelete |
Suspend |
boolean |
None. |
|
|
string |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"disableWithoutDelete": true,
"eMail": "sample string 2"
},
{
"disableWithoutDelete": true,
"eMail": "sample string 2"
}
]
Response Information
Amount of successful and failed deletions with error messages
| Name | Description | Type | Additional information |
|---|---|---|---|
| ProcessedSuccessfully | integer |
None. |
|
| Errors | integer |
None. |
|
| Messages | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"processedSuccessfully": 1,
"errors": 2,
"messages": "sample string 3"
}