Update Role

Beta

PATCH/v1/identity/roles/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates a custom role's name or permissions. Provided permissions replace all existing ones; global roles cannot be modified.

idstring

Role ID.

include[]optional arrayenumValues:ownerowner.accountpermissions

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

namestring

Display name.

permissionsarray of string

Permissions in <domain>:<action> format. Replaces all existing permissions; omit to leave unchanged.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name.

typestringenumValues:adminuserscanner

Role type code.

ownerobjectExpandablenullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.

portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

permissionsarray of stringExpandablenullable

Permissions in {domain}:{action} format.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Role

Update Role

curl API_HOST/v1/identity/roles/{id} \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated Manager",
  "permissions": [
    "customers:read",
    "customers:update"
  ]
}'

curl API_HOST/v1/identity/roles/{id} \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated Manager",
  "permissions": [
    "customers:read",
    "customers:update"
  ]
}'

200 example

{
  "id": "rl_01gf7a8200er3ar3pkfrb6kk29",
  "object": "role",
  "name": "Admin",
  "type": "admin",
  "owner": {
    "object": "owner",
    "type": "account",
    "account": {
      "id": "ac_01gf7a8200eaj8fke1xvw4h50x",
      "object": "account",
      "name": "Acme Inc.",
      "default_billing_address": null,
      "default_shipping_address": null,
      "branding": null,
      "portal": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "permissions": [
    "customers:create",
    "customers:read",
    "customers:update",
    "customers:delete"
  ],
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "rl_01gf7a8200er3ar3pkfrb6kk29",
  "object": "role",
  "name": "Admin",
  "type": "admin",
  "owner": {
    "object": "owner",
    "type": "account",
    "account": {
      "id": "ac_01gf7a8200eaj8fke1xvw4h50x",
      "object": "account",
      "name": "Acme Inc.",
      "default_billing_address": null,
      "default_shipping_address": null,
      "branding": null,
      "portal": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "permissions": [
    "customers:create",
    "customers:read",
    "customers:update",
    "customers:delete"
  ],
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Role

Path Parameters

Query Parameters

Request Body

Returns

Responses