Contents
On this page

Create Checkpoint - Plugixa Image Map

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

Keep the map as it is now as a named checkpoint. Checkpoints are never removed to make room.

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

Request

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

Path parameters

Name Type Description
id integer The map’s id

Request body

Content type: application/json

Field Type Required Description
label string No Plain text, cut at 120 characters. Empty or omitted gives Checkpoint. 
{
  "label": "Before the reprint"
}

Responses

201 Created. data is the new revision, without its document.

{
  "success": true,
  "data": {
    "id": 85,
    "map_id": 12,
    "rev": 4,
    "kind": "manual",
    "label": "Before the reprint",
    "doc_hash": "3a7bd3e2360a3d29eea436fcfb7e44c735d117c4",
    "created_by": 1,
    "created_at": "2026-11-12 10:10:00",
    "author": "Alex Martin"
  }
}
Field Type Meaning
data.id integer The revision’s id
data.map_id integer The map
data.rev integer The map’s rev when this version was kept
data.kind string save (kept on every save), manual (a checkpoint) or restore (kept when a revision was restored)
data.label string The checkpoint’s name, or the restore note. Empty for plain saves

Errors

Status Code When
404 plugixa_image_map_not_found No map with that id, or the map is in the trash.
500 plugixa_image_map_save_failed The checkpoint could not be written.

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" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"label":"Before the reprint"}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-image-map/v1/maps/12/revisions');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'label' => 'Before the reprint',
    ]),
]);
$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', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    label: 'Before the reprint',
  }),
});
const { data } = await response.json();

Quick Links

Share