Update a Group

Updates information for an existing group within your Fivetran account.

Request schema

Path parameters

groupId

stringrequired

The unique identifier for the group within the Fivetran system.

example:

groupId

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Request

name

string

The name of the group within your account.

example:

Updated_Group_Name

Http + 1.1

PATCH

https://api.fivetran.com/v1/groups/groupId

PATCH /v1/groups/groupId HTTP/1.1
Accept: application/json
Authorization: Basic 
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 34

{
  "name": "Updated_Group_Name"
}

Responses

200

Successful response

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Group has been updated

data

objectrequired

stringrequired

The unique identifier for the group within the Fivetran system.

example:

group_id

name

stringrequired

The name of the group within your account.

example:

Group_Name

created_at

stringrequired

The timestamp of when the group was created in your account.

format:

date-time

example:

2024-01-01T00:00:00Z

{
  "code": "Success",
  "message": "Group has been updated",
  "data": {
    "id": "group_id",
    "name": "Group_Name",
    "created_at": "2024-01-01T00:00:00Z"
  }
}