> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/Falasefemi2/companyflow/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Role

> Update an existing role

Update a role's information. All fields are optional - only provide the fields you want to update. Requires Super Admin or HR Manager permissions.

<Note>
  This endpoint supports both `PUT` and `PATCH` methods.
</Note>

## Path Parameters

<ParamField path="id" type="string" required>
  The unique identifier of the role (UUID format)

  **Example:** `"550e8400-e29b-41d4-a716-446655440000"`
</ParamField>

## Request Body

<ParamField body="name" type="string">
  Name of the role. Must be between 2 and 50 characters if provided.

  **Example:** `"Lead Developer"`
</ParamField>

<ParamField body="description" type="string">
  Description of the role.

  **Example:** `"Lead software development position"`
</ParamField>

<ParamField body="permissions_cache" type="string[]">
  Array of cached permission strings.

  **Example:** `["employees:read", "employees:write", "employees:delete"]`
</ParamField>

## Response

<ResponseField name="success" type="boolean">
  Indicates if the request was successful
</ResponseField>

<ResponseField name="data" type="object">
  The updated role object

  <Expandable title="Role Object">
    <ResponseField name="id" type="string">
      Unique identifier for the role
    </ResponseField>

    <ResponseField name="company_id" type="string">
      The company this role belongs to
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the role
    </ResponseField>

    <ResponseField name="description" type="string">
      Description of the role
    </ResponseField>

    <ResponseField name="is_system_role" type="boolean">
      Whether this is a system-defined role
    </ResponseField>

    <ResponseField name="permissions_cache" type="string[]">
      Array of cached permission strings
    </ResponseField>

    <ResponseField name="created_at" type="string">
      ISO 8601 timestamp of when the role was created
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      ISO 8601 timestamp of when the role was last updated
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X PUT https://api.companyflow.com/roles/550e8400-e29b-41d4-a716-446655440000 \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Lead Developer",
      "description": "Lead software development position"
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://api.companyflow.com/roles/550e8400-e29b-41d4-a716-446655440000',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        name: 'Lead Developer',
        description: 'Lead software development position'
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.companyflow.com/roles/550e8400-e29b-41d4-a716-446655440000"
  headers = {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
  }
  payload = {
      "name": "Lead Developer",
      "description": "Lead software development position"
  }

  response = requests.put(url, json=payload, headers=headers)
  data = response.json()
  ```
</RequestExample>

<ResponseExample>
  ```json 200 - Success theme={null}
  {
    "success": true,
    "data": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "company_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Lead Developer",
      "description": "Lead software development position",
      "is_system_role": false,
      "permissions_cache": ["employees:read", "employees:write"],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T15:45:00Z"
    }
  }
  ```

  ```json 400 - Bad Request theme={null}
  {
    "success": false,
    "message": "invalid role id"
  }
  ```

  ```json 401 - Unauthorized theme={null}
  {
    "success": false,
    "message": "unauthorized"
  }
  ```
</ResponseExample>