Update Client

Update existing client settings and permission assignments.

Endpoint

/api/v1/projects/{project_id}/clients/{client_id}

Method

PUT

Path Parameters

Parameter	Type	Required	Description
`project_id`	`string`	Yes	Unique ID of the project
`client_id`	`string`	Yes	Unique ID of the client

Headers

Header	Required	Description
`Content-Type`	Yes	`application/json`
`Authorization`	Yes	Bearer access token: `Bearer <access_token>`

Request Body

Field	Type	Required	Description
`name`	`string`	Yes	Client name (max 50 chars)
`description`	`string`	No	Description (max 200 chars)
`is_active`	`boolean`	Yes	Active status
`permission_ids`	`array of strings`	No	List of permission IDs

Required Permission

clients:update

Examples

curl --request PUT \
  --url https://auth.roled.io/api/v1/projects/2JUSLUee46xG6iEwG8JwPc/clients/2JUdYi26caQ2pMgQweYJrk \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJo...' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Read Only Client",
    "description": "Read-only access for reporting service with enhanced reporting capabilities",
    "is_active": true,
    "permission_ids": [
      "2JUUyotLUr7SuBqkzjRbTc",
      "2JUUyotLUrApxL7zcx7Xoy",
      "2JRjbZKS7f4oRkDaAD4gAF",
      "2JRjbZKS7fJAfNjgShH3TE",
      "2JRjbZKS7h72qSpPAJBuSj",
      "2JRjbZKS7feihqSQx5D8yf"
    ]
  }'

{
  "success": true,
  "data": {
    "id": "2JUdYi26caQ2pMgQweYJrk",
    "created_at": "2026-07-29T07:52:55Z",
    "updated_at": "2026-07-29T08:30:00Z",
    "name": "Read Only Client",
    "description": "Read-only access for reporting service with enhanced reporting capabilities",
    "is_default": false,
    "is_active": true,
    "permissions": [
      {
        "id": "2JUUyotLUr7SuBqkzjRbTc",
        "resource_name": "Products",
        "permission_name": "Read"
      },
      {
        "id": "2JUUyotLUrApxL7zcx7Xoy",
        "resource_name": "Products",
        "permission_name": "Update"
      },
      {
        "id": "2JRjbZKS7f4oRkDaAD4gAF",
        "resource_name": "Orders",
        "permission_name": "Read"
      },
      {
        "id": "2JRjbZKS7fJAfNjgShH3TE",
        "resource_name": "Orders",
        "permission_name": "Update"
      },
      {
        "id": "2JRjbZKS7h72qSpPAJBuSj",
        "resource_name": "Users",
        "permission_name": "Read"
      },
      {
        "id": "2JRjbZKS7feihqSQx5D8yf",
        "resource_name": "Roles",
        "permission_name": "Read"
      }
    ]
  }
}

Error Codes

Code	HTTP Status	Description
`invalid_params`	400	Invalid or missing request parameters, headers, or body.
`invalid_authorization_token`	401	Unauthorized request. The authorization token is missing or invalid.
`insufficient_permission`	403	Insufficient permissions to access this resource.
`project_not_found`	404	The requested project could not be found.
`client_not_found`	404	The requested client could not be found.
`some_permissions_not_found`	404	The following permissions could not be found.
`system_error`	500	An unexpected error occurred. Please try again later.

Create Client Delete Client