Skip to content

Delete Users

The Delete Users API deletes a user from Volt MX Foundry Engagement Services. This service accepts the user ID as an input parameter to delete a user.

URL

The HTTP URL for Delete Users API is:

http://<host>:<port>/api/v1/audience/<id>/delete

This API implements Gateway Filter for Authentication/Basic Authentication to authenticate access of the service by a user.

Method

POST

The payload's request header includes Content-Type as application/json;charset=UTF-8.

Input Parameters

The following fields are input parameters:

Input Parameter Required Type Description
User ID Yes long The unique ID assigned to a user

Sample Response

{
"id" : "8",
"message" : "User deleted successfully"
}

Response Status

Code Description
Status 200 User deleted successfully
Status 400 Invalid audience member ID provided or no audience member found with given ID
Status 401 Unauthorized request
Status 500 Server failure to process request