Update a Filter Chain¶

Change the information of an existing filter chain.

Endpoint¶

PATCH https://api.crowdynews.com/collection/chains/{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 chain. The consumer that wants to update the chain must have access to the contract said chain 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 chain in a human readable way and must be unique inside a contract.
sets	Array	Optional. Contains set resource IDs that specify which filter rules to use. The `sets` property can be empty.
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 chain 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/chains/565d4de40d6f659557f63243?access_token={your access token}

{
    "sets": "[ ]"
}

Response:

HTTP/1.1 201

{
    "_id": "565d4de40d6f659557f63243",
    "created": "2016-03-22T15:01:49.081Z",
    "createdBy": "John Doe",
    "lastModified": "2016-03-22T15:01:49.081Z",
    "lastModifiedBy": "John Doe",
    "active": true,
    "name": "My Chain",
    "contractId": "565c4df4056e859526e62257",
    "sets": [ ]
}