Create a Filter Chain¶

Create a filter chain to start using filter rules in order to control content manually.

Endpoint¶

POST https://api.crowdynews.com/collection/chains

Request Parameters¶

HEADER FIELD	VALUE DESCRIPTION
Content-Type	The content type of the request body, must be set to `application/json`.

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	Identifies the chain in a human readable way and must be unique inside a contract. This name can be changed after creation.
contractId	String	The resource ID that specifies to which contract this chain belongs. The consumer that wants to create the chain must have access to the provided contract, otherwise this action is forbidden.
sets	Array	May contain set resource IDs that specify which filter rules to use. The `sets` property can be empty.
active	Boolean	Optional. Specifies if this chain will be processed by the platform. This property defaults to `true` when omitted.

Response Format¶

On success, the HTTP status code in the response header is 201 Created 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:

POST https://api.crowdynews.com/collection/chains?access_token={your access token}

{
    "name": "My Chain",
    "contractId": "565c4df4056e859526e62257"
    "sets": [
        "565d4de4056f859526d53389"
    ]
}

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": [
        "565d4de4056f859526d53389"
    ]
}