Skip to main content
PATCH
/
organizations
/
{organizationName}
/
groups
/
{groupName}
Update group configuration
curl --request PATCH \
  --url https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/groups/{groupName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organizationName": "<string>",
  "groupName": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
'
{
  "organizationName": "<string>",
  "groupName": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
​
groupName
string
required

The unique identifier of the group Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

Represents a user group for organizing users and managing group-based permissions

​
organizationName
string

The name of the organization that owns this group

Pattern: ^[a-zA-Z0-9_-]+$
​
groupName
string

The unique identifier for the group within the organization

Pattern: ^[a-zA-Z0-9_-]+$
​
description
string

Human-readable description of the group's purpose and membership

​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the group was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when the group was last modified

Response

Group updated successfully

Represents a user group for organizing users and managing group-based permissions

​
organizationName
string

The name of the organization that owns this group

Pattern: ^[a-zA-Z0-9_-]+$
​
groupName
string

The unique identifier for the group within the organization

Pattern: ^[a-zA-Z0-9_-]+$
​
description
string

Human-readable description of the group's purpose and membership

​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the group was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when the group was last modified