# Update an item family

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Idempotency Supported](/docs/api/idempotency)

This endpoint updates the name and/or description of the item family.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/item_families/acme-inc \
     -u {site_api_key}:\
     -d description="Acme Inc Family"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = ItemFamily.Update("acme-inc")
		.Description("Acme Inc Family")
		.Request();

ItemFamily itemFamily = result.ItemFamily;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    itemfamilyAction "github.com/chargebee/chargebee-go/v3/actions/itemfamily"
    "github.com/chargebee/chargebee-go/v3/models/itemfamily"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := itemfamilyAction.Update("acme-inc", &itemfamily.UpdateRequestParams{
        Description : "Acme Inc Family",
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        ItemFamily := res.ItemFamily
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.ItemFamilyUpdateRequest{
    Description : "Acme Inc Family",
}
  res, err := client.ItemFamily.Update("acme-inc", req)
      if err != nil {
        fmt.Println(err)
    } else {
        ItemFamily := res.ItemFamily
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = ItemFamily.update("acme-inc")
            .description("Acme Inc Family")
            .request();

        ItemFamily itemFamily = result.itemFamily();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.itemFamily.ItemFamily;
import com.chargebee.v4.models.itemFamily.params.ItemFamilyUpdateParams;
import com.chargebee.v4.models.itemFamily.responses.ItemFamilyUpdateResponse;

public class ItemFamilyUpdate {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        ItemFamilyUpdateParams params = ItemFamilyUpdateParams.builder()
            .description("Acme Inc Family")
            .build();

        ItemFamilyUpdateResponse response = client
            .itemFamilies()
            .update("acme-inc", params);

        ItemFamily itemFamily = response.getItemFamily();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.itemFamily.update("acme-inc", {
        description: "Acme Inc Family"
    });

    console.log(result);
    const itemFamily = result.item_family;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->itemFamily()->update("acme-inc", [
    "description" => "Acme Inc Family"
]);
$itemFamily = $result->item_family;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.ItemFamily.update("acme-inc",
    cb_client.ItemFamily.UpdateParams(
        description="Acme Inc Family"
    )
)
item_family = response.item_family
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::ItemFamily.update("acme-inc",{
  :description => "Acme Inc Family"
})

item_family = result.item_family
```

## Sample Response

```json
{
  "item_family": {
    "description": "Acme Inc Family",
    "id": "acme-inc",
    "name": "Acme Inc Family",
    "resource_version": 1576400460281,
    "updated_at": 1576400460
  }
}
```

## URL Format

**POST** https://[site].chargebee.com/api/v2/item_families/{item-family-id}

## Input Parameters

- `name` (optional, string, max chars=50)
  The display name for the item family. Must be unique. This is visible only in Chargebee and not to customers.

- `description` (optional, string, max chars=500)
  Description of the item family. This is visible only in Chargebee and not to customers.

## Returns

- `item_family` (Item family object)
  Resource object representing item\_family