Update Role - Plugixa Advanced User Role Editor

PATCH /plugixa-aure/v1/roles/{slug}

Rename a role, replace its capabilities, or both in one request.

Needs the Edit roles permission: plugixa_aure_edit_roles.

Note. capabilities is the role’s whole map, not a list of changes. A capability the role holds now and that is missing from what you send is taken away. Read the role first with List Roles and send the full map back.

Request

PATCH https://your-site.example/wp-json/plugixa-aure/v1/roles/support_agent

Path parameters

Request body

Content type: application/json

The rename is saved first. If the capability change is then refused, the new name stays. Send real JSON booleans inside capabilities; null is dropped. Every change goes through the safety guardrails, and a restore point is taken before it is saved.

{
  "name": "Support team",
  "capabilities": {
    "read": true,
    "edit_posts": true,
    "moderate_comments": true,
    "upload_files": true
  }
}

Responses

200 OK. The role was saved.

The keys depend on what you sent: roles comes with a rename or a capability change, change and grants only with a capability change. With neither, data is just {"role": "..."}.

{
  "success": true,
  "data": {
    "role": "support_agent",
    "roles": [
      {
        "slug": "administrator",
        "name": "Administrator",
        "users": 2,
        "granted": 61,
        "denied": 0,
        "version": "9b1e44c0a7d2",
        "protected": true,
        "editable": false,
        "assignable": true
      },
      {
        "slug": "editor",
        "name": "Editor",
        "users": 4,
        "granted": 34,
        "denied": 0,
        "version": "3f9c2a71b0de",
        "protected": false,
        "editable": true,
        "assignable": true
      },
      {
        "slug": "support_agent",
        "name": "Support agent",
        "users": 0,
        "granted": 3,
        "denied": 1,
        "version": "5d0a8e13c4f7",
        "protected": false,
        "editable": true,
        "assignable": true
      }
    ],
    "change": {
      "granted": [],
      "revoked": [],
      "denied": [],
      "cleared": [
        "upload_files"
      ]
    },
    "grants": {
      "administrator": {
        "install_plugins": 1,
        "manage_options": 1,
        "read": 1
      },
      "editor": {
        "edit_posts": 1,
        "publish_posts": 1,
        "read": 1
      },
      "support_agent": {
        "edit_posts": 1,
        "moderate_comments": 1,
        "read": 1,
        "upload_files": 0
      }
    }
  }
}

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X PATCH "https://your-site.example/wp-json/plugixa-aure/v1/roles/support_agent" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"name":"Support team","capabilities":{"read":true,"edit_posts":true,"moderate_comments":true,"upload_files":true}}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-aure/v1/roles/support_agent');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PATCH',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'name'         => 'Support team',
        'capabilities' => [
            'read'              => true,
            'edit_posts'        => true,
            'moderate_comments' => true,
            'upload_files'      => true,
        ],
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-aure/v1/roles/support_agent', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Support team', capabilities: { read: true, edit_posts: true, moderate_comments: true, upload_files: true } }),
});
const { data } = await response.json();