Update a team - Rootly

Overview

Overview

Reference

AlertEvents
AlertGroups
AlertUrgencies
AlertSources
Alerts
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
Causes
[DEPRECATED] CustomFieldOptions
[DEPRECATED] CustomFields
CustomForms
DashboardPanels
Dashboards
Environments
EscalationPolicies
EscalationLevelsPolicies
EscalationLevelsPath
EscalationLevels
EscalationPaths
FormFieldOptions
FormFieldPlacementConditions
FormFieldPlacements
FormFieldPositions
FormFields
FormSetConditions
FormSets
Functionalities
WorkflowTasks
[DEPRECATED] WorkflowCustomFieldSelections
WorkflowFormFieldConditions
WorkflowGroups
WorkflowRuns
Workflows
Heartbeats
IncidentActionItems
[DEPRECATED] IncidentCustomFieldSelections
IncidentEventFunctionalities
IncidentEventServices
IncidentEvents
IncidentFeedbacks
IncidentFormFieldSelections
IncidentPermissionSetBooleans
IncidentPermissionSetResources
IncidentPermissionSets
IncidentRetrospectives
IncidentRetrospectiveSteps
IncidentRoleTasks
IncidentRoles
IncidentStatusPageEvents
IncidentSubStatuses
IncidentTypes
Incidents
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
Pulses
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
Roles
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Shifts
Secrets
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
- GET
  List teams
- POST
  Creates a team
- GET
  Retrieves a team
- PUT
  Update a team
- DEL
  Delete a team
- GET
  Get team incidents chart
UserNotificationRules
Users
WebhooksDeliveries
WebhooksEndpoints

PUT

teams

{id}

curl --request PUT \
  --url https://api.rootly.com/v1/teams/%7Bid%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/vnd.api+json'

{
  "data": {
    "id": "eaf15d0b-c0b8-481a-bdef-24819f60bf0b",
    "type": "groups",
    "attributes": {
      "slug": "security",
      "name": "Security",
      "description": "Everything security related",
      "color": "#000",
      "position": 2,
      "notify_emails": [
        "hello@rootly.com",
        "world@rootly.com"
      ],
      "slack_channels": [
        {
          "id": "C03MKDSEJE8",
          "name": "infrastructure"
        }
      ],
      "slack_aliases": [
        {
          "id": "S03F7QUV7F1",
          "name": "infrastructure"
        }
      ],
      "pagerduty_id": "PQ9K7I9",
      "pagerduty_service_id": null,
      "backstage_id": null,
      "external_id": "95ee00ee-4b35-40f7-bd0f-a919f9b8008d",
      "opsgenie_id": "a6edf90f-1a61-4592-99a7-bcf101c81bca",
      "victor_ops_id": "0ae4de13-145a-4214-9cd5-c982ef95a740",
      "pagertree_id": "c4378a92-505c-49e4-a46e-c44c830bbc99",
      "cortex_id": null,
      "service_now_ci_sys_id": null,
      "user_ids": [
        500
      ],
      "admin_ids": [],
      "incidents_count": 1,
      "alert_urgency_id": null,
      "alerts_email_enabled": false,
      "alerts_email_address": "group-896c940b98efd5884454eeb5ea7ba795@email.rootly.com",
      "created_at": "2025-03-05T15:13:33.262-08:00",
      "updated_at": "2025-03-05T15:13:40.806-08:00"
    },
    "relationships": {
      "users": {
        "data": [
          {
            "id": "500",
            "type": "users"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

application/vnd.api+json

data

object

required

data.type

enum<string>

required

Available options:

groups

data.attributes

object

required

data.attributes.name

string

The name of the team

data.attributes.description

string | null

The description of the team

data.attributes.notify_emails

string[] | null

Emails to attach to the team

data.attributes.color

string | null

The hex color of the team

data.attributes.position

integer | null

Position of the team

data.attributes.backstage_id

string | null

The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name

data.attributes.external_id

string | null

The external id associated to this team

data.attributes.pagerduty_id

string | null

The PagerDuty group id associated to this team

data.attributes.pagerduty_service_id

string | null

The PagerDuty service id associated to this team

data.attributes.opsgenie_id

string | null

The Opsgenie group id associated to this team

data.attributes.victor_ops_id

string | null

The VictorOps group id associated to this team

data.attributes.pagertree_id

string | null

The PagerTree group id associated to this team

data.attributes.cortex_id

string | null

The Cortex group id associated to this team

data.attributes.service_now_ci_sys_id

string | null

The Service Now CI sys id associated to this team

data.attributes.user_ids

integer[] | null

The user ids of the members of this team.

data.attributes.admin_ids

integer[] | null

The user ids of the admins of this team. These users must also be present in user_ids attribute.

data.attributes.alerts_email_enabled

boolean | null

Enable alerts through email

data.attributes.alert_urgency_id

string | null

The alert urgency id of the team

data.attributes.slack_channels

object[] | null

Slack Channels associated with this team

data.attributes.slack_aliases

object[] | null

Slack Aliases associated with this team

Response

200

application/vnd.api+json

team updated

data

object

required

data.id

string

required

Unique ID of the team

data.type

enum<string>

required

Available options:

groups

data.attributes

object

required

data.attributes.name

string

required

The name of the team

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.slug

string

data.attributes.description

string | null

The description of the team

data.attributes.notify_emails

string[] | null

Emails to attach to the team

data.attributes.color

string | null

The hex color of the team

data.attributes.position

integer | null

Position of the team

data.attributes.backstage_id

string | null

The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name

data.attributes.external_id

string | null

The external id associated to this team

data.attributes.pagerduty_id

string | null

The PagerDuty group id associated to this team

data.attributes.pagerduty_service_id

string | null

The PagerDuty service id associated to this team

data.attributes.opsgenie_id

string | null

The Opsgenie group id associated to this team

data.attributes.victor_ops_id

string | null

The VictorOps group id associated to this team

data.attributes.pagertree_id

string | null

The PagerTree group id associated to this team

data.attributes.cortex_id

string | null

The Cortex group id associated to this team

data.attributes.service_now_ci_sys_id

string | null

The Service Now CI sys id associated to this team

data.attributes.user_ids

integer[] | null

The user ids of the members of this team.

data.attributes.admin_ids

integer[] | null

The user ids of the admins of this team. These users must also be present in user_ids attribute.

data.attributes.alerts_email_enabled

boolean | null

Enable alerts through email

data.attributes.alerts_email_address

string | null

Email generated to send alerts to

data.attributes.alert_urgency_id

string | null

The alert urgency id of the team

data.attributes.slack_channels

object[] | null

Slack Channels associated with this team

data.attributes.slack_aliases

object[] | null

Slack Aliases associated with this team

Was this page helpful?

Delete a teamDelete a specific team by id

curl --request PUT \
  --url https://api.rootly.com/v1/teams/%7Bid%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/vnd.api+json'

{
  "data": {
    "id": "eaf15d0b-c0b8-481a-bdef-24819f60bf0b",
    "type": "groups",
    "attributes": {
      "slug": "security",
      "name": "Security",
      "description": "Everything security related",
      "color": "#000",
      "position": 2,
      "notify_emails": [
        "hello@rootly.com",
        "world@rootly.com"
      ],
      "slack_channels": [
        {
          "id": "C03MKDSEJE8",
          "name": "infrastructure"
        }
      ],
      "slack_aliases": [
        {
          "id": "S03F7QUV7F1",
          "name": "infrastructure"
        }
      ],
      "pagerduty_id": "PQ9K7I9",
      "pagerduty_service_id": null,
      "backstage_id": null,
      "external_id": "95ee00ee-4b35-40f7-bd0f-a919f9b8008d",
      "opsgenie_id": "a6edf90f-1a61-4592-99a7-bcf101c81bca",
      "victor_ops_id": "0ae4de13-145a-4214-9cd5-c982ef95a740",
      "pagertree_id": "c4378a92-505c-49e4-a46e-c44c830bbc99",
      "cortex_id": null,
      "service_now_ci_sys_id": null,
      "user_ids": [
        500
      ],
      "admin_ids": [],
      "incidents_count": 1,
      "alert_urgency_id": null,
      "alerts_email_enabled": false,
      "alerts_email_address": "group-896c940b98efd5884454eeb5ea7ba795@email.rootly.com",
      "created_at": "2025-03-05T15:13:33.262-08:00",
      "updated_at": "2025-03-05T15:13:40.806-08:00"
    },
    "relationships": {
      "users": {
        "data": [
          {
            "id": "500",
            "type": "users"
          }
        ]
      }
    }
  }
}