Update a Filter List

Change the information of an existing filter list.

Endpoint

PATCH https://api.crowdynews.com/collection/lists/{id}

Request Parameters

HEADER FIELD VALUE DESCRIPTION
Content-Type The content type of the request body, must be set to application/json.
URL PARAMETER VALUE DESCRIPTION
id The resource ID of the list. The consumer that wants to update the list must have access to the contract said list belongs to, otherwise this action is forbidden.
QUERY PARAMETER VALUE DESCRIPTION
access_token A valid OAuth access token with the correct permission(s).
REQUEST BODY DATA VALUE TYPE VALUE DESCRIPTION
name String Optional. Identifies the list in a human readable way and must be unique inside a contract.
entries Array Optional. Contains rule values. Depending on the list type, the entries are either plain strings or string patterns.
active Boolean Optional. Specifies if this collection will be processed by the platform.

Response Format

On success, the HTTP status code in the response header is 200 OK and the response body will contain a list Object in JSON format. On error, the header status code is an error code and the response body contains an error object.

Example Request

Request:

PATCH https://api.crowdynews.com/collection/lists/565d4de40d6f659557f64356?access_token={your access token}

{
    "entries": [
        "/shi+t*/i"
    ]
}

Response:

HTTP/1.1 201

{
    "_id": "565d4de40d6f659557f64356",
    "created": "2016-03-22T15:01:49.081Z",
    "createdBy": "John Doe",
    "lastModified": "2016-03-22T15:01:49.081Z",
    "lastModifiedBy": "John Doe",
    "active": true,
    "contractId": "565c4df4056e859526e62257",
    "name": "My Profanity Pattern List",
    "type": "patterns",
    "entries": [
        "/shi+t*/i"
    ]
}

Additional Resources