# Update filter

PUT https://hublinks.io/rest/accounts/{account_id}/campaigns/{campaign_id}/filters/{filter_id}
Content-Type: application/json

Update a filter.

**Request body fields (wrapped in `campaign` object):**
- `name` (string, required) - Human-readable campaign name.
- `account_id` (string, required) - Target account ID.
- `status` (string, optional) - `DRAFT` | `RUN` | `PAUSE` | `DONE`. Defaults to `DRAFT`.
- `seats` (array of strings, required) - Seat IDs to run this campaign.
- `schedule` (object, required) - Day-of-week schedule. Each day key maps to `[enabled (bool), start_hour (int), end_hour (int)]`.
- `timezone` (integer, optional) - UTC offset in minutes (e.g. `-300` = UTC-5).
- `campaign_id` (string, optional) - Supply to create with a specific ID; omit to auto-generate.

Reference: https://api.hublinks.io/api-reference/filters/update-filter

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /rest/accounts/{account_id}/campaigns/{campaign_id}/filters/{filter_id}:
    put:
      operationId: update-filter
      summary: Update filter
      description: >-
        Update a filter.


        **Request body fields (wrapped in `campaign` object):**

        - `name` (string, required) - Human-readable campaign name.

        - `account_id` (string, required) - Target account ID.

        - `status` (string, optional) - `DRAFT` | `RUN` | `PAUSE` | `DONE`.
        Defaults to `DRAFT`.

        - `seats` (array of strings, required) - Seat IDs to run this campaign.

        - `schedule` (object, required) - Day-of-week schedule. Each day key
        maps to `[enabled (bool), start_hour (int), end_hour (int)]`.

        - `timezone` (integer, optional) - UTC offset in minutes (e.g. `-300` =
        UTC-5).

        - `campaign_id` (string, optional) - Supply to create with a specific
        ID; omit to auto-generate.
      tags:
        - subpackage_filters
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
        - name: campaign_id
          in: path
          required: true
          schema:
            type: string
        - name: filter_id
          in: path
          required: true
          schema:
            type: string
        - name: X-API-KEY
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Filters_Update filter_Response_200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PutRestAccountsAccount_cd855c2bb1cc72097238CampaignsCampaign_test_123FiltersFilter_abcd1234RequestBadRequestError
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PutRestAccountsAccount_cd855c2bb1cc72097238CampaignsCampaign_test_123FiltersFilter_abcd1234RequestUnauthorizedError
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
              required:
                - status
servers:
  - url: https://hublinks.io
components:
  schemas:
    RestAccountsAccountIdCampaignsCampaignIdFiltersFilterIdPutResponsesContentApplicationJsonSchemaFilterStats:
      type: object
      properties:
        fetch_errors:
          type: integer
        profiles_fetched:
          type: integer
      required:
        - fetch_errors
        - profiles_fetched
      title: >-
        RestAccountsAccountIdCampaignsCampaignIdFiltersFilterIdPutResponsesContentApplicationJsonSchemaFilterStats
    RestAccountsAccountIdCampaignsCampaignIdFiltersFilterIdPutResponsesContentApplicationJsonSchemaFilterFilters:
      type: object
      properties:
        data_cleansing:
          type: boolean
        include_degree_1:
          type: boolean
      required:
        - data_cleansing
        - include_degree_1
      title: >-
        RestAccountsAccountIdCampaignsCampaignIdFiltersFilterIdPutResponsesContentApplicationJsonSchemaFilterFilters
    RestAccountsAccountIdCampaignsCampaignIdFiltersFilterIdPutResponsesContentApplicationJsonSchemaFilter:
      type: object
      properties:
        type:
          type: string
        stats:
          $ref: >-
            #/components/schemas/RestAccountsAccountIdCampaignsCampaignIdFiltersFilterIdPutResponsesContentApplicationJsonSchemaFilterStats
        status:
          type: string
        filters:
          $ref: >-
            #/components/schemas/RestAccountsAccountIdCampaignsCampaignIdFiltersFilterIdPutResponsesContentApplicationJsonSchemaFilterFilters
        seat_id:
          type: string
        url_page:
          type: string
          format: uri
        filter_id:
          type: string
        account_id:
          type: string
        created_at:
          type: integer
        campaign_id:
          type: string
        max_profiles:
          type: integer
        filter_group_id:
          type: string
        profile_fetch_type:
          type: string
        fetch_progress_page:
          type: integer
      required:
        - type
        - stats
        - status
        - filters
        - seat_id
        - url_page
        - filter_id
        - account_id
        - created_at
        - campaign_id
        - max_profiles
        - filter_group_id
        - profile_fetch_type
        - fetch_progress_page
      title: >-
        RestAccountsAccountIdCampaignsCampaignIdFiltersFilterIdPutResponsesContentApplicationJsonSchemaFilter
    Filters_Update filter_Response_200:
      type: object
      properties:
        success:
          type: boolean
        filter:
          $ref: >-
            #/components/schemas/RestAccountsAccountIdCampaignsCampaignIdFiltersFilterIdPutResponsesContentApplicationJsonSchemaFilter
      required:
        - success
        - filter
      title: Filters_Update filter_Response_200
    PutRestAccountsAccount_cd855c2bb1cc72097238CampaignsCampaign_test_123FiltersFilter_abcd1234RequestBadRequestError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      title: >-
        PutRestAccountsAccount_cd855c2bb1cc72097238CampaignsCampaign_test_123FiltersFilter_abcd1234RequestBadRequestError
    PutRestAccountsAccount_cd855c2bb1cc72097238CampaignsCampaign_test_123FiltersFilter_abcd1234RequestUnauthorizedError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      title: >-
        PutRestAccountsAccount_cd855c2bb1cc72097238CampaignsCampaign_test_123FiltersFilter_abcd1234RequestUnauthorizedError
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

```

## SDK Code Examples

```python Filters_Update filter_example
import requests

url = "https://hublinks.io/rest/accounts/account_id/campaigns/campaign_id/filters/filter_id"

payload = { "status": "PAUSED" }
headers = {
    "X-API-KEY": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript Filters_Update filter_example
const url = 'https://hublinks.io/rest/accounts/account_id/campaigns/campaign_id/filters/filter_id';
const options = {
  method: 'PUT',
  headers: {'X-API-KEY': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"status":"PAUSED"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Filters_Update filter_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://hublinks.io/rest/accounts/account_id/campaigns/campaign_id/filters/filter_id"

	payload := strings.NewReader("{\n  \"status\": \"PAUSED\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-API-KEY", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Filters_Update filter_example
require 'uri'
require 'net/http'

url = URI("https://hublinks.io/rest/accounts/account_id/campaigns/campaign_id/filters/filter_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"PAUSED\"\n}"

response = http.request(request)
puts response.read_body
```

```java Filters_Update filter_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://hublinks.io/rest/accounts/account_id/campaigns/campaign_id/filters/filter_id")
  .header("X-API-KEY", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"PAUSED\"\n}")
  .asString();
```

```php Filters_Update filter_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://hublinks.io/rest/accounts/account_id/campaigns/campaign_id/filters/filter_id', [
  'body' => '{
  "status": "PAUSED"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Filters_Update filter_example
using RestSharp;

var client = new RestClient("https://hublinks.io/rest/accounts/account_id/campaigns/campaign_id/filters/filter_id");
var request = new RestRequest(Method.PUT);
request.AddHeader("X-API-KEY", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"status\": \"PAUSED\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Filters_Update filter_example
import Foundation

let headers = [
  "X-API-KEY": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["status": "PAUSED"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://hublinks.io/rest/accounts/account_id/campaigns/campaign_id/filters/filter_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```