This API operation removes a user from a hotlist.
POST
/v1/HotLists/RemoveUserFromHotList
Property | Type | Description |
---|---|---|
UserID |
integer | Required. ID of the user to remove from the Hotlist |
ListID |
integer | ID of the Hotlist. Removes the user from the default HotList if empty. |
Parameters can be passed to this operation using the HTTP POST method with serialized JSON in the request body.
The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.
An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.
This endpoint requires the following scope:
Scope |
---|
profile_hotlist |
Property | Type | Description |
---|---|---|
string | 200 OK |
The following example shows a sample string returned by the API.