---
title: "Partial Update Team"
method: PATCH
path: "/teams/{id}/"
tags: ["Teams"]
---

# Partial Update Team

`PATCH /teams/{id}/`

## Path parameters

- `id` string, required — A unique Base58 value identifying this object.

## Request body

- PatchedTeam
  - `id` string — A unique Base58 value identifying this object.
  - `name` string — Name of the team. Maximum length is 255 characters.
  - `num_api_keys` integer — Number of API Keys added to the team.
  - `num_users` integer — Number of users in the team.
  - `num_targets` integer — Number of targets added to the team.
  - `quota` integer, nullable — Number of targets the team can create.
  - `reserve` boolean — If true, the account has target slots reserved for the team to ensure the fulfillment of the team's quota. Defaults to false.
  - `targets` VerySimpleScope[] — Targets of the team.
    - `id` string, required
    - `name` string, required — Name of the target. The maximum length is 255 characters.
    - `site` SimpleTarget, required
      - `id` string, required — A unique Base58 value identifying this object.
      - `name` string — Name of the target or extra host. The maximum length is 255 characters.
      - `url` string — URL of the target.
      - `changed` string, date-time, required — Date and time of the last change, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302".
      - `changed_by` SimpleUser, required
        - `id` string, required — A unique Base58 value identifying this object.
        - `email` string, email — Email of the user.
        - `name` string, required — Name of the user.
    - `type` string, required — Type of target. Possible values are "single" for a web application and "api" for an API. Defaults to "single".
    - `desc` string, nullable, required — Description of the target. Defaults to "".
    - `labels` ScopeLabel[], required
      - `id` string, required — A unique Base58 value identifying this object.
      - `name` string, required — Name of the label. The maximum length is 255 characters.
      - `color` string — Color of the label, in RGB hexadecimal format prefixed with "#". For example, "#00FF00" for green.
      - `changed_by` SimpleUser, required
        - `id` string, required — A unique Base58 value identifying this object.
        - `email` string, email — Email of the user.
        - `name` string, required — Name of the user.
      - `changed` string, date-time, required — Date and time of the last change, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302".
    - `has_assets` boolean, required
    - `report_fileformat` 'pdf' | 'docx', required — [Report format](https://help.probely.com/en/articles/6649585-how-to-switch-between-different-report-formats) for the target: (Defaults to `pdf`) * `pdf` - PDF file format. * `docx` - DOCX file format.
    - `scanning_agent` ScanningAgent, required — Return serializer_class with all fields as read_only except key. The key is the field use to retrieve the object in `to_internal_value`. This is for the drf-spectacular documentation generation.
      - `id` string
      - `name` string, required
      - `installer_generated` boolean, required
      - `online` boolean, required
      - `fallback` boolean, required
      - `rx_bytes` integer, required
      - `tx_bytes` integer, required
      - `latest_handshake` integer, required
    - `teams` SimpleTeam[], required
      - `id` string — A unique Base58 value identifying this object.
      - `name` string, required
    - `blackout_period` BlackoutPeriod, required
      - `begin` string, time, required — Time of when the blackout period starts, in ISO 8601 UTC format. For example, "13:27".
      - `cease` string, time, required — Time of when the blackout period ceases, in ISO 8601 UTC format. For example, "13:27".
      - `weekdays` integer[], required
      - `enabled` boolean — If true, the blackout period is enabled.
      - `timezone` string
      - `changed` string, date-time, required — Date and time of the last change, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302".
      - `changed_by` SimpleUser, required
        - `id` string, required — A unique Base58 value identifying this object.
        - `email` string, email — Email of the user.
        - `name` string, required — Name of the user.
  - `scanning_agents` ScanningAgent[] — Scanning agents of the team. Learn more about [How to scan internal applications with a Scanning Agent?](https://help.probely.com/en/articles/4615595-how-to-scan-internal-applications-with-a-scanning-agent).
    - `id` string
    - `name` string, required
    - `installer_generated` boolean, required
    - `online` boolean, required
    - `fallback` boolean, required
    - `rx_bytes` integer, required
    - `tx_bytes` integer, required
    - `latest_handshake` integer, required
  - `num_available_targets` integer — Number of available targets.

## Response `200`

- Team
  - `id` string, required — A unique Base58 value identifying this object.
  - `name` string, required — Name of the team. Maximum length is 255 characters.
  - `num_api_keys` integer, required — Number of API Keys added to the team.
  - `num_users` integer, required — Number of users in the team.
  - `num_targets` integer, required — Number of targets added to the team.
  - `quota` integer, nullable — Number of targets the team can create.
  - `reserve` boolean — If true, the account has target slots reserved for the team to ensure the fulfillment of the team's quota. Defaults to false.
  - `targets` VerySimpleScope[] — Targets of the team.
    - `id` string, required
    - `name` string, required — Name of the target. The maximum length is 255 characters.
    - `site` SimpleTarget, required
      - `id` string, required — A unique Base58 value identifying this object.
      - `name` string — Name of the target or extra host. The maximum length is 255 characters.
      - `url` string — URL of the target.
      - `changed` string, date-time, required — Date and time of the last change, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302".
      - `changed_by` SimpleUser, required
        - `id` string, required — A unique Base58 value identifying this object.
        - `email` string, email — Email of the user.
        - `name` string, required — Name of the user.
    - `type` string, required — Type of target. Possible values are "single" for a web application and "api" for an API. Defaults to "single".
    - `desc` string, nullable, required — Description of the target. Defaults to "".
    - `labels` ScopeLabel[], required
      - `id` string, required — A unique Base58 value identifying this object.
      - `name` string, required — Name of the label. The maximum length is 255 characters.
      - `color` string — Color of the label, in RGB hexadecimal format prefixed with "#". For example, "#00FF00" for green.
      - `changed_by` SimpleUser, required
        - `id` string, required — A unique Base58 value identifying this object.
        - `email` string, email — Email of the user.
        - `name` string, required — Name of the user.
      - `changed` string, date-time, required — Date and time of the last change, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302".
    - `has_assets` boolean, required
    - `report_fileformat` 'pdf' | 'docx', required — [Report format](https://help.probely.com/en/articles/6649585-how-to-switch-between-different-report-formats) for the target: (Defaults to `pdf`) * `pdf` - PDF file format. * `docx` - DOCX file format.
    - `scanning_agent` ScanningAgent, required — Return serializer_class with all fields as read_only except key. The key is the field use to retrieve the object in `to_internal_value`. This is for the drf-spectacular documentation generation.
      - `id` string
      - `name` string, required
      - `installer_generated` boolean, required
      - `online` boolean, required
      - `fallback` boolean, required
      - `rx_bytes` integer, required
      - `tx_bytes` integer, required
      - `latest_handshake` integer, required
    - `teams` SimpleTeam[], required
      - `id` string — A unique Base58 value identifying this object.
      - `name` string, required
    - `blackout_period` BlackoutPeriod, required
      - `begin` string, time, required — Time of when the blackout period starts, in ISO 8601 UTC format. For example, "13:27".
      - `cease` string, time, required — Time of when the blackout period ceases, in ISO 8601 UTC format. For example, "13:27".
      - `weekdays` integer[], required
      - `enabled` boolean — If true, the blackout period is enabled.
      - `timezone` string
      - `changed` string, date-time, required — Date and time of the last change, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302".
      - `changed_by` SimpleUser, required
        - `id` string, required — A unique Base58 value identifying this object.
        - `email` string, email — Email of the user.
        - `name` string, required — Name of the user.
  - `scanning_agents` ScanningAgent[] — Scanning agents of the team. Learn more about [How to scan internal applications with a Scanning Agent?](https://help.probely.com/en/articles/4615595-how-to-scan-internal-applications-with-a-scanning-agent).
    - `id` string
    - `name` string, required
    - `installer_generated` boolean, required
    - `online` boolean, required
    - `fallback` boolean, required
    - `rx_bytes` integer, required
    - `tx_bytes` integer, required
    - `latest_handshake` integer, required
  - `num_available_targets` integer, required — Number of available targets.

## Other responses

- `400`
- `401`
- `404`
- `500`

---

[API](https://skmtc.net/probely/apis/snyk-api-web-s-api-reference-documentation.md) · [All operations](https://skmtc.net/probely/apis/snyk-api-web-s-api-reference-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/probely/snyk-api-web-s-api-reference-documentation/versions/e29879bff01b/schema)