PATCH: /user-list

Required authorization scope

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

Parameters

Send a partial JSON representation of the UserList in the request body, with just the fields you want to update. Any non-editable fields will be ignored.

The users field should contain an array of JSON representations of UserListEntry objects. Any UserListEntry objects with a uuid that is not already in the collection will cause it to be added to the collection. There is one very important special case to point out: to remove an existing user from the UserListEntry collection, the operation field must be set to null. An omitted operation will cause an idempotent attempt to create a new user entry with a default value of "operation": "include".

Example request

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

curl --request PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer OAUTH2_ACCESS_TOKEN' \
    -d '{
    "name": "My Vendors",
    "description": "A description of this list.",
    "parent_id": null,
    "users": [
    	{
    		"uuid": "32a9a4d0-cb6e-463f-a0ab-63d0a0418bc7",
    		"operation": "include"
    	},
    	{
    		"uuid": "20c66651-85f4-40c7-9d53-13201bde6ad2"
    	},
    	{
    		"uuid": "4db49e76-e0b1-44e5-8d64-8def1250f495",
    		"operation": "exclude"
    	},
    	{
    		"uuid": "9881a11b-c25e-48ab-9317-5005e2b4ca83",
    		"operation": null
    	},
    	{
    		"uuid": "3b09eaee-b57f-4ee2-abdb-1b51cf703011",
    		"operation": null
    	}
    ]
}' \
    https://api.proz.com/v2/user-list

Response

On success, a 200 OK HTTP status code will be returned, along with the current full UserList.

On error, a standard error response will be returned.

If a request fails because access is denied, a 403 Unauthorized HTTP status code will be returned, along with an error string explaining the reason.