> ## Documentation Index
> Fetch the complete documentation index at: https://docsv4.mile.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Create geofence group

> Creates a geofence group. A name already used by another group in your organization returns `400`.

Requires permission `add/geofence`.



## OpenAPI

````yaml /openapi/public/openapi-monitoring.json post /geofence-group
openapi: 3.0.0
info:
  title: API - Monitoring
  version: 3.0.0
  description: API Documentation - RESTful API for field operations management.
servers:
  - url: https://apiweb.mile.app/api/v3
security:
  - bearerAuth: []
tags:
  - name: Alert
    description: >-
      An alert is an event raised while monitoring field users and vehicles, for
      example entering or leaving a geofence, idling too long, a predicted late
      task, a route deviation or a panic button press. You can list alerts, read
      a daily summary, and mark them resolved. These endpoints are served under
      `/api/v4`.
  - name: Alert Setting
    description: >-
      Alert settings switch each alert type on or off for your organization.
      These endpoints are served under `/api/v4`.
  - name: Geofence
    description: >-
      A geofence is an area drawn on the map, as a polygon or a circle. Alerts
      and automations can react when a field user enters or leaves it, or stays
      inside longer than its dwell time.
  - name: Geofence Group
    description: >-
      Geofence groups organize geofences so you can filter and manage them
      together.
paths:
  /geofence-group:
    post:
      tags:
        - Geofence Group
      summary: Create geofence group
      description: >-
        Creates a geofence group. A name already used by another group in your
        organization returns `400`.


        Requires permission `add/geofence`.
      operationId: createGeofenceGroup
      requestBody:
        $ref: '#/components/requestBodies/GeofenceGroupRequest'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Status of response.
                  message:
                    description: Message of API response.
                    type: string
                  data:
                    description: Created geofence group.
                    type: object
                    additionalProperties: true
                example:
                  status: true
                  message: Data successfully created.
                  data:
                    _id: 66e0a0b1c2d3e4f5a6b7c8d9
                    name: Warehouses
                    organizationId: 64d99303be0ad015c461c932
                    createdBy: admin@example.com
                    updatedTime: '2026-09-15T02:00:00.000000Z'
                    createdTime: '2026-09-15T02:00:00.000000Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Bad request - invalid parameters provided.
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Internal server error, please contact support@mile.app.
      deprecated: false
      security:
        - bearerAuth: []
components:
  requestBodies:
    GeofenceGroupRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GeofenceGroupRequest'
      required: true
  schemas:
    GeofenceGroupRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          maxLength: 100
          description: |-
            Group name. Maximum 100 characters, unique within your organization.
            **Example:** `Warehouses`
      example:
        name: Warehouses
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use a valid Bearer token to authenticate.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.