---
title: "Update deployment group"
method: PUT
path: "/v1/default/deployment-groups/{group-id}"
tags: ["deployment-groups-api"]
---

# Update deployment group

`PUT /v1/default/deployment-groups/{group-id}`

## Request

- Base URL: `https://api.bymason.com`
- URL: `https://api.bymason.com/v1/default/deployment-groups/{group-id}`
- Auth: API key in header `Authorization`

Updates a deployment group.

## Path parameters

- `group-id` string, uuid, required

## Request body

- UpdateGroupRequest: Request for updating a Deployment Group
  - `description` string: Description for the Deployment Group.

## Response `200`

Update group response

- DeploymentGroup: Group of devices with the same artifacts.
  - `id` string, uuid, required: unique ID for the group
  - `name` string, required: Group name
  - `createdAt` string, date-time, required: Date group was created
  - `updatedAt` string, date-time, required: Date group was last updated
  - `description` string: Description of the group
  - `deviceFamily` 'D03' | 'F07' | 'D450' | 'D450A' | 'D450A1' | 'D450B' | 'C210' | 'F210' | 'F450' | 'G430' | 'G450' | 'I3399A' | 'A4100' | 'D215'
  - `apiLevel` 23 | 25 | 27 | 30
  - `deviceCount` integer, required: Number of devices currently in the group
  - `devicesUpToDateCount` integer: Of the devices in the group, indicates how many are running *all* the desired deployment versions
  - `apps` object[]: Details of each app (APK) deployed to the group
    - `createdAt` string: Date app was deployed to group
    - `name` string: Package name of the app
    - `version` string
  - `config` object: Details of the configuration deployed to the group
    - `createdAt` string: Date configuration was deployed to group
    - `name` string: Configuration name
    - `version` string
  - `os` object: Details of the OS deployed to the group
    - `createdAt` string: Date OS was deployed to group
    - `name` string
    - `version` string

## Other responses

- `400`: Bad request
- `404`: Resource(s) not found
- `500`: Internal server error

---

[API](https://skmtc.dev/bymason/apis/mason-platform-apis-docs.md) - [All operations](https://skmtc.dev/bymason/apis/mason-platform-apis-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/bymason/apis/mason-platform-apis-docs/revisions/365b123b04d4?raw)