This API operation adds a new hotlist.
POST
/v1/HotLists/AddHotList
Property | Type | Description |
---|---|---|
Name |
string | Required. The name of the hotlist to add. |
Members |
integer array | The UserIDs to be added to the hotlist. |
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 | The ID of the newly added hotlist |
The following example shows a sample id returned by the API.