Supported Formats

json

GET /api/website_filters
Lists filters.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
user_id
required

Filters listing for given user

Validations:

  • Must be a String


GET /api/website_filters/:id
Shows website filter.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
optional

Website Filter ID

Validations:

  • Must be a String


PUT /api/website_filters/:id
Update filter

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Filter Not Found

Params

Param name Description
id
required

Filter ID

Validations:

  • Must be a String

name
required

Name of filter

Validations:

  • Must be a String

filter
required

Filter

Validations:

  • Must be a Hash

is_shared_with_account
optional

True or false

Validations:

  • Must be a Boolean


POST /api/website_filters
Creates new domain.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Filter Not Found.

Params

Param name Description
user_id
required

User Id

Validations:

  • Must be a String

name
required

Name of filter

Validations:

  • Must be a String

filter
required

Filter

Validations:

  • Must be a Hash

is_shared_with_account
optional

True or false

Validations:

  • Must be a Boolean


DELETE /api/website_filters/:id
Delete filter

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Filter Not Found

Params

Param name Description
id
required

Filter ID

Validations:

  • Must be a String