Update group

PUT 
/:organization_id/groups/:id

Updates a specific group

Request

Path Parameters

organization_id integerrequired

Organization ID

id integerrequired

Group ID

application/json

Bodyrequired

namestringrequired
Name of the group (must be unique within the organization)
custom_fieldsobject
Custom fields for this group. Fields are defined by the organization's custom_group_fields. Values will be coerced to appropriate types:
• Boolean fields will be coerced to true/false
• Number fields will be coerced to floating point
• Date fields will be coerced to date objects

Responses

200

Group updated successfully

application/json

Schema

Schema

idintegerrequired

Unique identifier for the group

organization_idintegerrequired

ID of the organization this group belongs to

namestringrequired

Name of the group (must be unique within the organization)

custom_fieldsobject

Custom fields defined for this group, with format depending on field types

created_atdate-time

Creation timestamp

updated_atdate-time

Last update timestamp

Example (auto)

{
  "id": 0,
  "organization_id": 0,
  "name": "string",
  "custom_fields": {},
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}

401

Unauthorized

403

Forbidden

404

Not found

422

Unprocessable Entity - Invalid input

Authorization: http

name: basicAuthtype: httpscheme: basicdescription: Basic authentication using API key ID and API key

• python
• nodejs
• ruby
• curl
• go
• php
• java
• powershell
• javascript
• rust

• HTTP.CLIENT
• REQUESTS

import http.client
import json

conn = http.client.HTTPSConnection("cloud-staging.cloverhound.com")
payload = ''
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
}
conn.request("PUT", "/:organization_id/groups/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Auth

Username

Password

Parameters

organization_id — pathrequired

id — pathrequired

Body required

{
  "name": "string",
  "custom_fields": {}
}