> ## Documentation Index > Fetch the complete documentation index at: https://docs.rootly.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a team > Update a specific team by id ## OpenAPI ````yaml https://rootly-heroku.s3.amazonaws.com/swagger/v1/swagger.json put /v1/teams/{id} openapi: 3.0.1 info: title: Rootly API v1 version: v1 license: name: Rootly url: https://rootly.com description: >+ # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: Bearer YOUR-TOKEN' \ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{"error": "Rate limit exceeded. Try again later."}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., "1000, 1000;window=3600" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: Bearer YOUR-TOKEN' \ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ``` x-logo: url: https://rootly-heroku.s3.us-east-1.amazonaws.com/swagger/v1/logo.png servers: - url: https://api.rootly.com security: [] paths: /v1/teams/{id}: parameters: - name: id in: path schema: anyOf: - type: string format: uuid description: Team UUID - type: string pattern: ^[a-z0-9_-]+$ description: Team slug required: true put: tags: - Teams summary: Update a team description: Update a specific team by id operationId: updateTeam parameters: [] requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/update_team' required: true responses: '200': description: team updated content: application/vnd.api+json: schema: $ref: '#/components/schemas/team_response' '403': description: feature not enabled for the organization content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_list' '404': description: resource not found content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_list' security: - bearer_auth: [] components: schemas: update_team: type: object properties: data: type: object properties: id: type: string description: >- Accepted for JSON:API client compatibility, but ignored. The resource to update is identified by the id in the path. type: type: string enum: - groups attributes: type: object properties: slug: type: string description: >- Deprecated. `slug` is derived from `name`; any submitted value is ignored. This property will be removed from the request schema in a future version. nullable: true deprecated: true name: type: string description: The name of the team description: type: string description: The description of the team nullable: true public_description: type: string description: The status page description of the team nullable: true notify_emails: type: array description: Emails to attach to the team items: type: string nullable: true color: type: string description: The hex color of the team nullable: true position: type: integer description: Position of the team nullable: true backstage_id: type: string description: >- The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name nullable: true external_id: type: string description: The external id associated to this team nullable: true pagerduty_id: type: string description: The PagerDuty group id associated to this team nullable: true pagerduty_service_id: type: string description: The PagerDuty service id associated to this team nullable: true opsgenie_id: type: string description: The Opsgenie group id associated to this team nullable: true victor_ops_id: type: string description: The VictorOps group id associated to this team nullable: true pagertree_id: type: string description: The PagerTree group id associated to this team nullable: true cortex_id: type: string description: The Cortex group id associated to this team nullable: true service_now_ci_sys_id: type: string description: The Service Now CI sys id associated to this team nullable: true scim_group_id: type: string description: >- The SCIM group id linked to this team. Membership syncs from the SCIM group while the team keeps its own name. Set to null to unlink. Sending the current id is a no-op; to pin a name-linked group, unlink then link. nullable: true scim_group_external_id: type: string description: >- Link by the SCIM group's externalId from your identity provider instead of scim_group_id. Write-only. Rejected when it names a different SCIM group than scim_group_id. nullable: true user_ids: type: array description: The user ids of the members of this team. items: type: integer nullable: true admin_ids: type: array description: >- The user ids of the admins of this team. These users must also be present in user_ids attribute. items: type: integer nullable: true alerts_email_enabled: type: boolean description: Enable alerts through email nullable: true alert_urgency_id: type: string description: The alert urgency id of the team nullable: true slack_channels: type: array description: Slack Channels associated with this team items: type: object properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name additionalProperties: false required: - id - name nullable: true slack_aliases: type: array description: Slack Aliases associated with this team items: type: object properties: id: type: string description: Slack alias ID name: type: string description: Slack alias name additionalProperties: false required: - id - name nullable: true alert_broadcast_enabled: type: boolean description: Enable alerts to be broadcasted to a specific channel nullable: true alert_broadcast_channel: type: object description: Slack channel to broadcast alerts to properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name additionalProperties: false required: - id nullable: true incident_broadcast_enabled: type: boolean description: Enable incidents to be broadcasted to a specific channel nullable: true incident_broadcast_channel: type: object description: Slack channel to broadcast incidents to properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name additionalProperties: false required: - id nullable: true auto_add_members_when_attached: type: boolean description: Auto add members to incident channel when team is attached nullable: true auto_add_members_scope: type: string enum: - 'off' - public_only - public_and_test - all description: >- Visibility-scoped auto-add behavior. Only present when the `enable_scoped_incident_channel_auto_add` feature flag is on for the organization. When set, it overrides `auto_add_members_when_attached`. nullable: true schedule_override_policy: type: string enum: - everyone - members - admins description: >- Who can create and update overrides for schedules owned by this team: `everyone` in the organization, only team `members`, or only team `admins`. Users still need override permission from their on-call role. Only available when the team-level schedule override policy feature is enabled for the organization. Requests that set it while that feature is disabled are rejected. properties: type: array items: type: object description: Set a value for a catalog property properties: catalog_property_id: type: string description: Catalog property ID value: type: string description: The property value required: - catalog_property_id - value description: Array of property values for this team. additionalProperties: false additionalProperties: false required: - type - attributes additionalProperties: false required: - data team_response: type: object properties: data: type: object properties: id: type: string description: Unique ID of the team type: type: string enum: - groups attributes: type: object allOf: - $ref: '#/components/schemas/team' required: - id - type - attributes included: type: array items: $ref: '#/components/schemas/jsonapi_included_resource' required: - data errors_list: type: object properties: errors: type: array items: type: object properties: title: type: string status: type: string code: type: string nullable: true detail: type: string nullable: true required: - title - status team: type: object properties: name: type: string description: The name of the team slug: type: string readOnly: true managed_by: type: string enum: - web - admin_web - api - terraform - pulumi - backstage - catalog_sync description: >- How this team is managed (provenance): web, api, terraform, etc. Read-only. description: type: string description: The description of the team nullable: true public_description: type: string description: The status page description of the team nullable: true notify_emails: type: array description: Emails to attach to the team items: type: string nullable: true color: type: string description: The hex color of the team nullable: true position: type: integer description: Position of the team nullable: true backstage_id: type: string description: >- The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name nullable: true external_id: type: string description: The external id associated to this team nullable: true pagerduty_id: type: string description: The PagerDuty group id associated to this team nullable: true pagerduty_service_id: type: string description: The PagerDuty service id associated to this team nullable: true opsgenie_id: type: string description: The Opsgenie group id associated to this team nullable: true victor_ops_id: type: string description: The VictorOps group id associated to this team nullable: true pagertree_id: type: string description: The PagerTree group id associated to this team nullable: true cortex_id: type: string description: The Cortex group id associated to this team nullable: true service_now_ci_sys_id: type: string description: The Service Now CI sys id associated to this team nullable: true scim_group_id: type: string description: The SCIM group id linked to this team nullable: true user_ids: type: array description: The user ids of the members of this team. items: type: integer nullable: true admin_ids: type: array description: >- The user ids of the admins of this team. These users must also be present in user_ids attribute. items: type: integer nullable: true alerts_email_enabled: type: boolean description: Enable alerts through email nullable: true alerts_email_address: type: string description: Email generated to send alerts to nullable: true alert_urgency_id: type: string description: The alert urgency id of the team nullable: true slack_channels: type: array description: Slack Channels associated with this team items: type: object properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name required: - id - name nullable: true slack_aliases: type: array description: Slack Aliases associated with this team items: type: object properties: id: type: string description: Slack alias ID name: type: string description: Slack alias name required: - id - name nullable: true alert_broadcast_enabled: type: boolean description: Enable alerts to be broadcasted to a specific channel nullable: true alert_broadcast_channel: type: object description: Slack channel to broadcast alerts to properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name nullable: true incident_broadcast_enabled: type: boolean description: Enable incidents to be broadcasted to a specific channel nullable: true incident_broadcast_channel: type: object description: Slack channel to broadcast incidents to properties: id: type: string description: Slack channel ID name: type: string description: Slack channel name nullable: true auto_add_members_when_attached: type: boolean description: Auto add members to incident channel when team is attached nullable: true auto_add_members_scope: type: string enum: - 'off' - public_only - public_and_test - all description: >- Visibility-scoped auto-add behavior. Only present when the `enable_scoped_incident_channel_auto_add` feature flag is on for the organization. When set, it overrides `auto_add_members_when_attached`. nullable: true schedule_override_policy: type: string enum: - everyone - members - admins description: >- Who can create and update overrides for schedules owned by this team: `everyone` in the organization, only team `members`, or only team `admins`. Users still need override permission from their on-call role. Only available when the team-level schedule override policy feature is enabled for the organization. Requests that set it while that feature is disabled are rejected. properties: type: array items: type: object description: Set a value for a catalog property properties: catalog_property_id: type: string description: Catalog property ID value: type: string description: The property value required: - catalog_property_id - value description: Array of property values for this team. nullable: true created_at: type: string description: Date of creation updated_at: type: string description: Date of last update required: - name - created_at - updated_at jsonapi_included_resource: type: object properties: id: type: string type: type: string attributes: type: object additionalProperties: true relationships: type: object additionalProperties: true required: - id - type securitySchemes: bearer_auth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.