POST api/users/deleteUsers?customerId={customerId}&countryId={countryId}&defaultPortalId={defaultPortalId}

Remove users

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

Customer Id

integer

Required

countryId

integer

None.

defaultPortalId

integer

None.

Body Parameters

List of users to delete

NameDescriptionTypeAdditional information
DisableWithoutDelete

Suspend

boolean

None.

EMail

Email

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

NameDescriptionTypeAdditional 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"
}