Explore documentation
  1. Welcome to Warehouse 👋
  2. Ingesting data
    1. Ingesting events
    2. S3 vs NVMe hosted data
    3. Host events in your S3 bucket
  3. Querying data
    1. Querying events & time series
    2. Writing ClickHouse SQL queries
    3. Query speeds
    4. Ad-hoc SQL API
    5. Generate client-facing APIs
    6. Visualizing data
  4. Vector embeddings
    1. Introduction to embeddings
    2. Using built-in embeddings
    3. Bringing your own embeddings
    4. Data structures and indices
  5. Use cases
    1. Retrieval Augmented Generation
  6. Management
    1. Controlling costs
  7. Warehouse API
    1. Getting an API token
    2. Warehouse sources API
    3. Warehouse source groups API
      1. List all groups GET
      2. Get a single group GET
      3. Create a group POST
      4. Update a group PUT
      5. Remove a group DELETE
      6. List sources in a group GET
    4. Time series API
    5. Embeddings API

Update a warehouse source group

Updates an existing Warehouse source group. Only provided parameters will be changed.

PATCH https://warehouse.betterstack.com/api/v1/source-groups/{id}

URL parameters

id
required string

The ID of the Warehouse source group to update.

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
required string

application/json

Body parameters

name
string

The new name for the source group. Must contain only letters, numbers, and underscores.

200

The updated Warehouse source group.

Response body

{
  "data": {
    "id": "1234",
    "type": "warehouse_source_group",
    "attributes": {
      "name": "analytics_updated",
      "created_at": "2025-11-13T10:00:00Z",
      "updated_at": "2025-11-25T20:44:50Z",
      "sort_index": null,
      "team_name": "example-team"
    }
  }
}
401

Unauthorized

Response body

{
  "errors": "Invalid authentication"
}
404

Not Found

Response body

{
  "errors": "Source group with the provided ID was not found"
}
422

Unprocessable Entity - Validation Errors

Response body

{
  "errors": "Validation errors",
  "invalid_values": {
    "name": [
      "already taken",
      "name must only contain letters, numbers, and underscores"
    ]
  }
}

Example cURL

Example
curl --request PATCH \
  --url https://warehouse.betterstack.com/api/v1/source-groups/1234 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "analytics_updated"
  }'

Previous article

Create a warehouse source group

Next article

Remove a warehouse source group