---
title: "PATCH /v2/agents/{agent_id}"
method: PATCH
path: "/v2/agents/{agent_id}"
tags: ["Agents"]
---

# PATCH /v2/agents/{agent_id}

`PATCH /v2/agents/{agent_id}`

## Request

- Base URL: `https://api.agenty.com`
- URL: `https://api.agenty.com/v2/agents/{agent_id}`
- Auth: HTTP bearer

Update an agent name, description and tags.

## Path parameters

- `agent_id` string, required

## Request body

- unknown

## Response `200`

- union
  - object
    - `agent_id` string, nullable
    - `account_id` integer, nullable
    - `user_id` integer, nullable
    - `project_id` integer, nullable
    - `name` string, required
    - `description` string, nullable
    - `tags` string[], required
    - `version` integer, nullable
    - `is_public` boolean, required
    - `is_managed` boolean, required
    - `input` union, required
      - object
        - `type` 'url', required
        - `data` string[], required
      - object
        - `type` 'manual', required
        - `data` string[], required
      - object
        - `type` 'list', required
        - `id` string, required
        - `field` string, required
      - object
        - `type` 'agent', required
        - `collection` integer, required
        - `id` string, required
        - `field` string, required
    - `scripts` object, nullable
      - `pre` union
        - object
          - `is_enabled` true, required
          - `code` string, required
        - object
          - `is_enabled` boolean
          - `code` string
      - `post` union
        - object
          - `is_enabled` true, required
          - `code` string, required
          - `is_parallel_execution` boolean
        - object
          - `is_enabled` boolean
          - `code` string
          - `is_parallel_execution` boolean
    - `settings` object, nullable
      - `batching_size` number, required
      - `concurrency` number, required
      - `headless` boolean, required
    - `dataset_type` string, nullable
    - `scheduler` object, nullable
      - `type` 'cron' | 'interval', required
      - `expression` string, required
      - `frequency` number, nullable
      - `description` string, nullable
      - `is_enabled` boolean, required
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `type` 'scraping', required
    - `config` object, required
      - `url` string, uri, required
      - `collections` object[], required
        - `name` string, required
        - `fields` union[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `query` string, nullable
        - `model` string, nullable
      - `code` string, nullable
      - `wait_for` object, required
        - `type` 'selector' | 'timeout' | 'script', required
        - `value` union
          - string
          - number
        - `hidden` boolean, nullable
        - `visible` boolean, nullable
        - `timeout` integer, required
        - `ignore_errors` boolean, nullable
      - `pagination` union, required
        - object
          - `enabled` boolean, required
        - object
          - `enabled` true, required
          - `type` 'click' | 'scroll' | 'loadmore' | 'script', required
          - `value` string, nullable
          - `container` string, nullable
          - `max_pages` integer, required
      - `form` object, required
        - `enabled` boolean, required
        - `actions` object[], required
          - `type` string, required
          - `value` string, nullable
          - `target` string, nullable
      - `login` object, required
        - `enabled` boolean, required
        - `actions` object[], required
          - `type` string, required
          - `value` string, nullable
          - `target` string, nullable
      - `logout` object, required
        - `enabled` boolean, required
        - `actions` object[], required
          - `type` string, required
          - `value` string, nullable
          - `target` string, nullable
      - `developer_mode` boolean, required
      - `go_to_options` object, required
        - `timeout` integer, required
        - `wait_until` string[], required
        - `referer` string, nullable
      - `browser` 'default' | 'puppeteer' | 'playwright' | 'fetch', required
      - `device` string, nullable
      - `retry` object, required
        - `enabled` boolean, required
        - `max_try` integer, required
        - `try_interval` integer, required
      - `viewport` object, required
        - `width` number, required
        - `height` number, required
      - `anonymous` object, required
        - `proxy` boolean, required
        - `country` string, nullable
        - `proxy_type` string, required
        - `skip_resource_types` string[], required
      - `block_ads` boolean, required
      - `block_trackers` boolean, required
      - `lazy_load` boolean, required
      - `accept_cookie_consent` boolean, required
      - `set_javascript_enabled` boolean, required
      - `headers` object[], required
        - `key` string, required
        - `value` string, required
      - `local_storage` object[], required
        - `key` string, required
        - `value` string, required
      - `session_storage` object[], required
        - `key` string, required
        - `value` string, required
      - `reject_resource_types` string[], required
      - `reject_request_pattern` string[], required
  - object
    - `agent_id` string, nullable
    - `account_id` integer, nullable
    - `user_id` integer, nullable
    - `project_id` integer, nullable
    - `name` string, required
    - `description` string, nullable
    - `tags` string[], required
    - `version` integer, nullable
    - `is_public` boolean, required
    - `is_managed` boolean, required
    - `input` union, required
      - object
        - `type` 'url', required
        - `data` string[], required
      - object
        - `type` 'manual', required
        - `data` string[], required
      - object
        - `type` 'list', required
        - `id` string, required
        - `field` string, required
      - object
        - `type` 'agent', required
        - `collection` integer, required
        - `id` string, required
        - `field` string, required
    - `scripts` object, nullable
      - `pre` union
        - object
          - `is_enabled` true, required
          - `code` string, required
        - object
          - `is_enabled` boolean
          - `code` string
      - `post` union
        - object
          - `is_enabled` true, required
          - `code` string, required
          - `is_parallel_execution` boolean
        - object
          - `is_enabled` boolean
          - `code` string
          - `is_parallel_execution` boolean
    - `settings` object, nullable
      - `batching_size` number, required
      - `concurrency` number, required
      - `headless` boolean, required
    - `dataset_type` string, nullable
    - `scheduler` object, nullable
      - `type` 'cron' | 'interval', required
      - `expression` string, required
      - `frequency` number, nullable
      - `description` string, nullable
      - `is_enabled` boolean, required
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `type` 'crawling', required
    - `config` object, required
      - `url` string, uri, required
      - `collections` object[], required
        - `name` string, required
        - `fields` union[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `query` string, nullable
        - `model` string, nullable
      - `wait_for` object, required
        - `type` 'selector' | 'timeout' | 'script', required
        - `value` union
          - string
          - number
        - `hidden` boolean, nullable
        - `visible` boolean, nullable
        - `timeout` integer, required
        - `ignore_errors` boolean, nullable
      - `max_results` number, required
      - `keep_cookies` boolean, required
      - `follow_sitemaps` boolean, required
      - `max_link_per_page` number, required
      - `max_time_to_crawl` number, required
      - `max_depth_to_crawl` number, required
      - `max_pages_to_crawl` number, required
      - `max_error_threshold` number, required
      - `respect_robots_txt` boolean, required
      - `respect_rel_nofollow` boolean, required
      - `follow_external_links` boolean, required
      - `should_crawl_external_pages` boolean, required
      - `should_crawl_internal_pages` boolean, required
      - `crawl_rules` string[], required
      - `process_rules` string[], required
      - `priority_rules` string[], required
      - `go_to_options` object, required
        - `timeout` integer, required
        - `wait_until` string[], required
        - `referer` string, nullable
      - `browser` 'default' | 'puppeteer' | 'playwright' | 'fetch', required
      - `device` string, nullable
      - `retry` object, required
        - `enabled` boolean, required
        - `max_try` integer, required
        - `try_interval` integer, required
      - `viewport` object, required
        - `width` number, required
        - `height` number, required
      - `anonymous` object, required
        - `proxy` boolean, required
        - `country` string, nullable
        - `proxy_type` string, required
        - `skip_resource_types` string[], required
      - `block_ads` boolean, required
      - `block_trackers` boolean, required
      - `lazy_load` boolean, required
      - `accept_cookie_consent` boolean, required
      - `set_javascript_enabled` boolean, required
      - `headers` object[], required
        - `key` string, required
        - `value` string, required
      - `local_storage` object[], required
        - `key` string, required
        - `value` string, required
      - `session_storage` object[], required
        - `key` string, required
        - `value` string, required
      - `reject_resource_types` string[], required
      - `reject_request_pattern` string[], required
  - object
    - `agent_id` string, nullable
    - `account_id` integer, nullable
    - `user_id` integer, nullable
    - `project_id` integer, nullable
    - `name` string, required
    - `description` string, nullable
    - `tags` string[], required
    - `version` integer, nullable
    - `is_public` boolean, required
    - `is_managed` boolean, required
    - `input` union, required
      - object
        - `type` 'url', required
        - `data` string[], required
      - object
        - `type` 'manual', required
        - `data` string[], required
      - object
        - `type` 'list', required
        - `id` string, required
        - `field` string, required
      - object
        - `type` 'agent', required
        - `collection` integer, required
        - `id` string, required
        - `field` string, required
    - `scripts` object, nullable
      - `pre` union
        - object
          - `is_enabled` true, required
          - `code` string, required
        - object
          - `is_enabled` boolean
          - `code` string
      - `post` union
        - object
          - `is_enabled` true, required
          - `code` string, required
          - `is_parallel_execution` boolean
        - object
          - `is_enabled` boolean
          - `code` string
          - `is_parallel_execution` boolean
    - `settings` object, nullable
      - `batching_size` number, required
      - `concurrency` number, required
      - `headless` boolean, required
    - `dataset_type` string, nullable
    - `scheduler` object, nullable
      - `type` 'cron' | 'interval', required
      - `expression` string, required
      - `frequency` number, nullable
      - `description` string, nullable
      - `is_enabled` boolean, required
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `type` 'changedetection', required
    - `config` object, required
      - `url` string, uri, required
      - `selector` string, required
      - `extract` 'TEXT' | 'ATTR' | 'HTML', required
      - `attribute` string, nullable
      - `keywords` string[], nullable, required
      - `keywords_change` 'added' | 'removed', nullable, required
      - `screenshot_type` 'visible' | 'full', required
      - `emails` string, nullable
      - `attach_screenshot` boolean, required
      - `ignore_minor_changes` boolean, required
      - `error_alert` boolean, required
      - `go_to_options` object, required
        - `timeout` integer, required
        - `wait_until` string[], required
        - `referer` string, nullable
      - `browser` 'default' | 'puppeteer' | 'playwright' | 'fetch', required
      - `device` string, nullable
      - `retry` object, required
        - `enabled` boolean, required
        - `max_try` integer, required
        - `try_interval` integer, required
      - `viewport` object, required
        - `width` number, required
        - `height` number, required
      - `anonymous` object, required
        - `proxy` boolean, required
        - `country` string, nullable
        - `proxy_type` string, required
        - `skip_resource_types` string[], required
      - `block_ads` boolean, required
      - `block_trackers` boolean, required
      - `lazy_load` boolean, required
      - `accept_cookie_consent` boolean, required
      - `set_javascript_enabled` boolean, required
      - `headers` object[], required
        - `key` string, required
        - `value` string, required
      - `local_storage` object[], required
        - `key` string, required
        - `value` string, required
      - `session_storage` object[], required
        - `key` string, required
        - `value` string, required
      - `reject_resource_types` string[], required
      - `reject_request_pattern` string[], required
  - object
    - `agent_id` string, nullable
    - `account_id` integer, nullable
    - `user_id` integer, nullable
    - `project_id` integer, nullable
    - `name` string, required
    - `description` string, nullable
    - `tags` string[], required
    - `version` integer, nullable
    - `is_public` boolean, required
    - `is_managed` boolean, required
    - `input` union, required
      - object
        - `type` 'url', required
        - `data` string[], required
      - object
        - `type` 'manual', required
        - `data` string[], required
      - object
        - `type` 'list', required
        - `id` string, required
        - `field` string, required
      - object
        - `type` 'agent', required
        - `collection` integer, required
        - `id` string, required
        - `field` string, required
    - `scripts` object, nullable
      - `pre` union
        - object
          - `is_enabled` true, required
          - `code` string, required
        - object
          - `is_enabled` boolean
          - `code` string
      - `post` union
        - object
          - `is_enabled` true, required
          - `code` string, required
          - `is_parallel_execution` boolean
        - object
          - `is_enabled` boolean
          - `code` string
          - `is_parallel_execution` boolean
    - `settings` object, nullable
      - `batching_size` number, required
      - `concurrency` number, required
      - `headless` boolean, required
    - `dataset_type` string, nullable
    - `scheduler` object, nullable
      - `type` 'cron' | 'interval', required
      - `expression` string, required
      - `frequency` number, nullable
      - `description` string, nullable
      - `is_enabled` boolean, required
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `type` 'mapmonitoring', required
    - `config` object, required
  - object
    - `agent_id` string, nullable
    - `account_id` integer, nullable
    - `user_id` integer, nullable
    - `project_id` integer, nullable
    - `name` string, required
    - `description` string, nullable
    - `tags` string[], required
    - `version` integer, nullable
    - `is_public` boolean, required
    - `is_managed` boolean, required
    - `input` union, required
      - object
        - `type` 'url', required
        - `data` string[], required
      - object
        - `type` 'manual', required
        - `data` string[], required
      - object
        - `type` 'list', required
        - `id` string, required
        - `field` string, required
      - object
        - `type` 'agent', required
        - `collection` integer, required
        - `id` string, required
        - `field` string, required
    - `scripts` object, nullable
      - `pre` union
        - object
          - `is_enabled` true, required
          - `code` string, required
        - object
          - `is_enabled` boolean
          - `code` string
      - `post` union
        - object
          - `is_enabled` true, required
          - `code` string, required
          - `is_parallel_execution` boolean
        - object
          - `is_enabled` boolean
          - `code` string
          - `is_parallel_execution` boolean
    - `settings` object, nullable
      - `batching_size` number, required
      - `concurrency` number, required
      - `headless` boolean, required
    - `dataset_type` string, nullable
    - `scheduler` object, nullable
      - `type` 'cron' | 'interval', required
      - `expression` string, required
      - `frequency` number, nullable
      - `description` string, nullable
      - `is_enabled` boolean, required
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `type` 'brandmonitoring', required
    - `config` object, required

---

[API](https://skmtc.dev/agenty/apis/web-scraping-api-agenty.md) - [All operations](https://skmtc.dev/agenty/apis/web-scraping-api-agenty/llms.txt) - [OpenAPI document](https://skmtc.dev/agenty/apis/web-scraping-api-agenty/revisions/5392481adaca?raw)