Restore Revision - Plugixa Image Map

POST /plugixa-image-map/v1/maps/{id}/revisions/{revision}/restore

Put the document of an earlier version back as the map’s current document.

Any signed-in user with the plugixa_image_map_edit capability. Administrators have every Plugixa Image Map capability; see Roles and permissions.

Note. Only the document comes back: the title and status stay as they are now. The restore is a save like any other (rev goes up by one and the document is cleaned again) and is itself kept as a restore revision, so it can be undone by restoring the version before it. No rev is sent or checked.

Request

POST https://your-site.example/wp-json/plugixa-image-map/v1/maps/12/revisions/85/restore

Path parameters

Responses

200 OK. data is the map as restored.

{
  "success": true,
  "data": {
    "id": 12,
    "uid": "9b2f6c1e-4d7a-4f3b-9a51-2c8e7d0f6a13",
    "title": "Ground floor (2026)",
    "status": "published",
    "image_id": 58,
    "doc": {
      "schema": 1,
      "image": {
        "attachment_id": 58,
        "width": 1600,
        "height": 1000,
        "alt": "Ground floor plan"
      },
      "settings": {
        "general": {
          "responsive": true
        },
        "tooltips": {
          "enabled": true,
          "trigger": "hover",
          "sticky": false,
          "constrain": true,
          "animation": "fade"
        },
        "effects": {
          "pageload": "none"
        },
        "zoom": {
          "enabled": false,
          "max": 4.0,
          "buttons": true,
          "wheel": "ctrl",
          "fullscreen": false
        },
        "list": {
          "enabled": false,
          "position": "right",
          "search": true,
          "title": ""
        }
      },
      "objects": [
        {
          "id": "o_3f9a1c2e",
          "type": "spot",
          "name": "Reception",
          "geometry": {
            "x": 42.5,
            "y": 61.25,
            "w": 3.0
          },
          "style": {
            "default": {
              "fill": "#1976d2",
              "fill_opacity": 0.4,
              "stroke": "#ffffff",
              "stroke_opacity": 1.0,
              "stroke_width": 0.0,
              "radius": 4.0,
              "opacity": 1.0,
              "icon": "pin",
              "icon_color": "#ffffff",
              "shadow": false
            },
            "hover": []
          },
          "action": {
            "type": "none",
            "new_tab": false,
            "url": "",
            "event": ""
          },
          "tooltip": {
            "enabled": true,
            "position": "auto",
            "width": 260,
            "offset_x": 0.0,
            "offset_y": 0.0,
            "content": "<p>Reception desk, open 8:00 to 18:00.</p>"
          },
          "a11y": {
            "label": "Reception",
            "description": ""
          },
          "visible": true,
          "locked": false,
          "group": "",
          "ext": []
        }
      ],
      "groups": [],
      "ext": []
    },
    "doc_version": 1,
    "trusted_html": true,
    "object_count": 1,
    "rev": 6,
    "created_by": 1,
    "modified_by": 1,
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 12:00:00",
    "deleted_at": null,
    "doc_error": false,
    "image_url": "https://your-site.example/wp-content/uploads/2026/11/ground-floor.png"
  }
}

Unlike the map routes, this answer has no shortcode or thumbnail_url and no meta.warnings. The other fields are those of Get Map.

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-image-map/v1/maps/12/revisions/85/restore" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-image-map/v1/maps/12/revisions/85/restore');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-image-map/v1/maps/12/revisions/85/restore', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data } = await response.json();