## Update

`client.Zones.Roles.Update(ctx, roleID, params) (*Role, error)`

**patch** `/zones/{zoneId}/roles/{roleId}`

Updates a customer-owned role's description. The identifier is immutable, and platform-owned roles cannot be modified.

### Parameters

- `roleID string`

- `params ZoneRoleUpdateParams`

  - `ZoneID param.Field[string]`

    Path param: Zone ID

  - `RoleUpdate param.Field[RoleUpdate]`

    Body param: Schema for updating an existing role. The role identifier is immutable.

### Returns

- `type Role struct{…}`

  A role that can be assigned to users within a zone.

  - `ID string`

    Unique identifier of the role

  - `CreatedAt Time`

    Entity creation timestamp

  - `Identifier string`

    Role identifier: a lowercase slug (letters and digits separated by single hyphens or underscores), unique per owner type within a zone. Role identifiers surface in policy evaluation, so the slug restriction keeps them unambiguous in policy text.

  - `OwnerType RoleOwnerType`

    Who owns this role. Platform-owned roles are managed by Keycard and cannot be modified or deleted via the API; customer-owned roles are user-created.

    - `const RoleOwnerTypePlatform RoleOwnerType = "platform"`

    - `const RoleOwnerTypeCustomer RoleOwnerType = "customer"`

  - `UpdatedAt Time`

    Entity update timestamp

  - `ZoneID string`

    Zone this role belongs to

  - `Description string`

    Human-readable description

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/keycardai/keycard-go"
  "github.com/keycardai/keycard-go/option"
)

func main() {
  client := keycard.NewClient(
    option.WithAPIKey("My API Key"),
  )
  role, err := client.Zones.Roles.Update(
    context.TODO(),
    "roleId",
    keycard.ZoneRoleUpdateParams{
      ZoneID: "zoneId",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", role.ID)
}
```