# set_guide_region

Set the map region (label, center, zoom, bbox).

`PUT /v1/guides/{productId}/region` · MCP tool `set_guide_region` · scope `write` · stable · since 2026-09-17

Full replacement of the map region the viewer opens on. Use a label buyers recognise (Yellowstone and Grand Teton), the center of the spots, a zoom of 8-11 for a region, and a bbox [west, south, east, north] that contains every spot.

## Path parameters

- `productId` (string, required): Id of the guide (a product of type map). From list_guides or create_guide.

## Body parameters

- `region` (MapRegion, required): Object with label, centerLat, centerLon, defaultZoom (0-22) and bbox [west, south, east, north].
  Fields of MapRegion: https://developers.sceniq.earth/fields/map-region.md

## Returns

200.

- `ok` (boolean, required): Always true: the write went through. Always `true`.
- `productId` (string, required): The guide's id.
- `region` (MapRegion, required): The region as sent.
  Fields of MapRegion: https://developers.sceniq.earth/fields/map-region.md

## Examples

### Open the map on both parks

```bash
curl -X PUT "https://sceniq.earth/api/v1/guides/j5738kd1q9x2m7v4c6b8n0p3r5t1w9y2/region" \
  -H "Authorization: Bearer $SCENIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "region": {
    "label": "Yellowstone and Yosemite",
    "centerLat": 41.2,
    "centerLon": -115,
    "defaultZoom": 5,
    "bbox": [
      -120,
      37.4,
      -109.8,
      45.2
    ]
  }
}'
```

MCP `tools/call`:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "set_guide_region",
    "arguments": {
      "productId": "j5738kd1q9x2m7v4c6b8n0p3r5t1w9y2",
      "region": {
        "label": "Yellowstone and Yosemite",
        "centerLat": 41.2,
        "centerLon": -115,
        "defaultZoom": 5,
        "bbox": [
          -120,
          37.4,
          -109.8,
          45.2
        ]
      }
    }
  }
}
```

Response 200:

```json
{
  "ok": true,
  "productId": "j5738kd1q9x2m7v4c6b8n0p3r5t1w9y2",
  "region": {
    "label": "Yellowstone and Yosemite",
    "centerLat": 41.2,
    "centerLon": -115,
    "defaultZoom": 5,
    "bbox": [
      -120,
      37.4,
      -109.8,
      45.2
    ]
  }
}
```

## Errors

- `invalid_argument` (400): A required field is missing, a field is unknown, or a value does not match its type (the Convex validator's path and value are in the message).
- `invalid_request` (400): A writer refused a value: a map link on a host that is not allowed, a title that is too long, a date that does not exist, too many items in a list. The message is the writer's own sentence.
- `unauthenticated` (401): The request carries no key. Send it as Authorization: Bearer sk_sceniq_... (or X-Api-Key).
- `invalid_api_key` (401): The key is unknown, revoked or expired.
- `api_scope_required` (403): A read-only key called a write operation, or a key without the publish option called publish_changes.
- `forbidden` (403): The key belongs to a creator account that is no longer active.
- `not_found` (404): The id does not exist or belongs to another creator. The two answers are identical on purpose, so ids never reveal what exists.
- `payload_too_large` (413): A JSON body over 2 MB, an image over 6 MB, a batch upload over 19 MB, or an MCP message over 2 MB.
- `rate_limited` (429): Over a limit: requests per key per minute, per creator per hour, uploads per key per minute, or check_links per guide per hour.
- `internal_error` (500): An unexpected failure. The message is hidden on purpose.

Reference: https://developers.sceniq.earth/reference/set_guide_region