Skip to main content
PUT
/
roles
/
{id}
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"
  }'

{
  "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"
  }
}

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 a role’s information. All fields are optional - only provide the fields you want to update. Requires Super Admin or HR Manager permissions.
This endpoint supports both PUT and PATCH methods.

​
Path Parameters

​
id
string
required
The unique identifier of the role (UUID format)Example: "550e8400-e29b-41d4-a716-446655440000"

​
Request Body

​
name
string
Name of the role. Must be between 2 and 50 characters if provided.Example: "Lead Developer"
​
description
string
Description of the role.Example: "Lead software development position"
​
permissions_cache
string[]
Array of cached permission strings.Example: ["employees:read", "employees:write", "employees:delete"]

​
Response

​
success
boolean
Indicates if the request was successful
​
data
object
The updated role object
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"
  }'

{
  "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"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us