Skip to main content
PATCH
/
roles
/
{role_id}
Update a Role
curl --request PATCH \
  --url https://api.emulator.farm/v1/roles/{role_id} \
  --header 'Content-Type: application/json' \
  --header 'X-EMULATOR-FARM-API-KEY: <api-key>' \
  --data '
{
  "name": "build-manager",
  "description": "Can create, view, and delete builds",
  "metadata": {}
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "build-manager",
  "created_at": "2025-12-10T12:00:00Z",
  "updated_at": "2025-12-10T12:00:00Z",
  "description": "Can create, view, and delete builds",
  "metadata": {}
}

Authorizations

​
X-EMULATOR-FARM-API-KEY
string
header
required

Path Parameters

​
role_id
string<uuid>
required

The unique identifier of the Role

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
​
name
string
Example:

"build-manager"

​
description
string | null
Example:

"Can create, view, and delete builds"

​
metadata
object

Response

Role updated successfully

​
id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string
required
Example:

"build-manager"

​
created_at
string<date-time>
required
Example:

"2025-12-10T12:00:00Z"

​
updated_at
string<date-time>
required
Example:

"2025-12-10T12:00:00Z"

​
description
string | null
Example:

"Can create, view, and delete builds"

​
metadata
object