---
title: "Update existing G Suite"
method: PATCH
path: "/gsuites/{id}"
tags: ["G Suite"]
---

# Update existing G Suite

`PATCH /gsuites/{id}`

## Request

- Base URL: `https://console.jumpcloud.com/api/v2`
- URL: `https://console.jumpcloud.com/api/v2/gsuites/{id}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/docs/gsuites/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows updating some attributes of a G Suite.

##### Sample Request

```
curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "userLockoutAction": "suspend",
    "userPasswordExpirationAction": "maintain"
  }'
```
Sample Request, set a default domain

```
curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "defaultDomain": {
        "id": "{domainObjectID}"
      }
  }'
```

Sample Request, unset the default domain

```
curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "defaultDomain": {}
  }'
```

## Headers

- `x-org-id` string

## Request body

- Gsuite
  - `id` string
  - `userLockoutAction` 'suspend' | 'maintain'
  - `userPasswordExpirationAction` 'suspend' | 'maintain' | 'remove_access'
  - `name` string
  - `groupsEnabled` boolean
  - `importFilter` string
  - `defaultDomain` DefaultDomain, nullable
    - `id` string
    - `domain` string
  - `organizationObjectId` string, byte: OrganizationObjectId is the object id of the organization that the account belongs to.

## Response `200`

- Gsuite
  - `id` string
  - `userLockoutAction` 'suspend' | 'maintain'
  - `userPasswordExpirationAction` 'suspend' | 'maintain' | 'remove_access'
  - `name` string
  - `groupsEnabled` boolean
  - `importFilter` string
  - `defaultDomain` DefaultDomain, nullable
    - `id` string
    - `domain` string
  - `organizationObjectId` string, byte: OrganizationObjectId is the object id of the organization that the account belongs to.

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/revisions/3f09fe63caaa?raw)