Update Settings - Plugixa Permalink Manager

PUT /plugixa-permalink-manager/v1/settings

Change one or more settings. Only the keys you send change.

Needs the plugixa_permalink_manager_manage_settings capability. Changing delete_data_on_uninstall also needs the WordPress manage_options capability. POST and PATCH are accepted too.

Note. An unknown key refuses the whole request and nothing is saved. A known key with a value it does not accept is not refused: it is saved as that setting’s default. Read the answer to see what was stored.

Request

PUT https://your-site.example/wp-json/plugixa-permalink-manager/v1/settings

Request body

Content type: application/json

A JSON object of setting keys and their new values, from the list below. null or [] clears a list setting; leaving a key out leaves it alone. Booleans accept true, 1, "1", "true", "on" and "yes" as on, and anything else as off.

{
  "redirect_status": 302,
  "external_redirect_hosts": [
    "shop.example.com"
  ]
}

Responses

200 OK. data.settings is every setting as saved.

{
  "success": true,
  "data": {
    "settings": {
      "delete_data_on_uninstall": false,
      "debug_mode": false,
      "safe_mode": false,
      "wizard_completed": true,
      "auto_update_uris": 0,
      "force_custom_slugs": 0,
      "disable_slug_sanitization": false,
      "keep_accents": false,
      "show_native_slug_field": false,
      "partial_disable_strict": true,
      "exclude_post_ids": "",
      "exclude_term_ids": "",
      "ignore_drafts": 1,
      "redirect_status": 302,
      "canonical_redirect": true,
      "extra_redirects": true,
      "setup_redirects": true,
      "trailing_slashes": 0,
      "trailing_slash_redirect": true,
      "copy_query_redirect": true,
      "sslwww_redirect": true,
      "external_redirect_policy": "allowlist",
      "external_redirect_hosts": [
        "shop.example.com"
      ],
      "max_redirects_per_item": 50,
      "edit_uris_cap": "publish_posts",
      "history_retention_days": 90,
      "partial_disable": {
        "post_types": [
          "attachment",
          "tribe_events",
          "e-landing-page",
          "elementor_library"
        ],
        "taxonomies": []
      }
    }
  }
}

Setting keys

Each key is a field on a tab of the Settings screen, where its effect is described.

Addresses

Content

Redirects

Advanced

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X PUT "https://your-site.example/wp-json/plugixa-permalink-manager/v1/settings" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"redirect_status":302,"external_redirect_hosts":["shop.example.com"]}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-permalink-manager/v1/settings');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'redirect_status'         => 302,
        'external_redirect_hosts' => ['shop.example.com'],
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`);
const response = await fetch('https://your-site.example/wp-json/plugixa-permalink-manager/v1/settings', {
  method: 'PUT',
  headers: {
    'Authorization': auth,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    redirect_status: 302,
    external_redirect_hosts: ['shop.example.com'],
  }),
});
const { data } = await response.json();