POST: /user-list

Required authorization scope

When using OAuth2 access tokens, the userlist scope is required to create an entry. See scopes in the authentication guide for information about how to request this scope of authorization.

Parameters

Pass the JSON representation of the UserList as the POST data.

Example request

Here's an example of submitting a request using curl:

curl -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer OAUTH2_ACCESS_TOKEN' \
    -d '{
    "name": "My Vendors",
    "description": "A description of this list.",
    "parent_id": 123,
    "users": [
    	{
    		"uuid": "32a9a4d0-cb6e-463f-a0ab-63d0a0418bc7",
    		"operation": "include"
    	},
    	{
    		"uuid": "20c66651-85f4-40c7-9d53-13201bde6ad2"
    	},
    	{
    		"uuid": "4db49e76-e0b1-44e5-8d64-8def1250f495",
    		"operation": "exclude"
    	}
    ]
}' \
    https://api.proz.com/v2/user-list

Response

On success, a 201 Created HTTP status code will be returned, along with the created UserList.

On error, a standard error response will be returned.