API reference

Access control

23 methods. Request fields, an example response, and notes on what comes back in data.

Base https://api.groove.com.na Updated October 2026

GET /api/events/:eventId/access/devices

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`label`	body	Y	Text field (min 1).
`gateId`	body	Y	Access-control gate identifier (min 1).
`gate`	body	Y	Text field (min 1).
`scannerId`	body	Y	Text field (min 1).
`battery`	body	N	Numeric value.
`status`	body	N	Lifecycle status for the resource.
`lastSeen`	body	N	Text field.
`version`	body	N	Text field.
`active`	body	N	Boolean flag.

Example body

{
  "label": "\u2026",
  "gateId": "\u2026",
  "gate": "\u2026",
  "scannerId": "\u2026",
  "battery": "\u2026",
  "status": "\u2026",
  "lastSeen": "\u2026",
  "version": "\u2026",
  "active": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/events/:eventId/access/devices

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`label`	body	Y	Text field (min 1).
`gateId`	body	Y	Access-control gate identifier (min 1).
`gate`	body	Y	Text field (min 1).
`scannerId`	body	Y	Text field (min 1).
`battery`	body	N	Numeric value.
`status`	body	N	Lifecycle status for the resource.
`lastSeen`	body	N	Text field.
`version`	body	N	Text field.
`active`	body	N	Boolean flag.

Example body

{
  "label": "\u2026",
  "gateId": "\u2026",
  "gate": "\u2026",
  "scannerId": "\u2026",
  "battery": "\u2026",
  "status": "\u2026",
  "lastSeen": "\u2026",
  "version": "\u2026",
  "active": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

DELETE /api/events/:eventId/access/devices/:id

Remove or deactivate this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`id`	path	Y	Path parameter identifying the resource.
`key`	body	N	Text field (min 1).
`id`	body	Y	Request field. See Zod schema in the route module for constraints.
`enabled`	body	Y	Request field. See Zod schema in the route module for constraints.
`name`	body	Y	Display name.
`description`	body	Y	Request field. See Zod schema in the route module for constraints.
`bullets`	body	Y	Request field. See Zod schema in the route module for constraints.
`_id`	body	Y	Request field. See Zod schema in the route module for constraints.
`key`	body	Y	Request field. See Zod schema in the route module for constraints.
`enabled`	body	Y	Request field. See Zod schema in the route module for constraints.
`confirmationCode`	body	Y	Text field (min 1).
`gateId`	body	Y	Access-control gate identifier (min 1).
`deviceId`	body	N	Gate or POS device identifier.
`scannerId`	body	N	Text field.
`supervisorOverride`	body	N	Boolean flag.
`overrideReason`	body	N	Text field.
`offlineMode`	body	N	Boolean flag.

Example body

{
  "key": "\u2026",
  "id": "\u2026",
  "enabled": "\u2026",
  "name": "\u2026",
  "description": "\u2026",
  "bullets": "\u2026",
  "_id": "\u2026",
  "confirmationCode": "\u2026",
  "gateId": "\u2026",
  "deviceId": "\u2026",
  "scannerId": "\u2026",
  "supervisorOverride": "\u2026",
  "overrideReason": "\u2026",
  "offlineMode": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

PATCH /api/events/:eventId/access/devices/:id

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`id`	path	Y	Path parameter identifying the resource.
`key`	body	N	Text field (min 1).
`id`	body	Y	Request field. See Zod schema in the route module for constraints.
`enabled`	body	Y	Request field. See Zod schema in the route module for constraints.
`name`	body	Y	Display name.
`description`	body	Y	Request field. See Zod schema in the route module for constraints.
`bullets`	body	Y	Request field. See Zod schema in the route module for constraints.
`_id`	body	Y	Request field. See Zod schema in the route module for constraints.
`key`	body	Y	Request field. See Zod schema in the route module for constraints.
`enabled`	body	Y	Request field. See Zod schema in the route module for constraints.
`confirmationCode`	body	Y	Text field (min 1).
`gateId`	body	Y	Access-control gate identifier (min 1).
`deviceId`	body	N	Gate or POS device identifier.
`scannerId`	body	N	Text field.
`supervisorOverride`	body	N	Boolean flag.
`overrideReason`	body	N	Text field.
`offlineMode`	body	N	Boolean flag.

Example body

{
  "key": "\u2026",
  "id": "\u2026",
  "enabled": "\u2026",
  "name": "\u2026",
  "description": "\u2026",
  "bullets": "\u2026",
  "_id": "\u2026",
  "confirmationCode": "\u2026",
  "gateId": "\u2026",
  "deviceId": "\u2026",
  "scannerId": "\u2026",
  "supervisorOverride": "\u2026",
  "overrideReason": "\u2026",
  "offlineMode": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/events/:eventId/access/gates

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`name`	body	Y	Display name (min 1).
`zone`	body	Y	Text field (min 1).
`zoneId`	body	Y	Access-control zone identifier (min 1).
`scansPerMin`	body	N	Numeric value.
`acceptedPct`	body	N	Numeric value.
`rejectedPct`	body	N	Numeric value.
`avgLatencyMs`	body	N	Numeric value.
`queueEstimate`	body	N	Numeric value.
`status`	body	N	Lifecycle status for the resource.
`maxScansPerMin`	body	N	Numeric value.
`active`	body	N	Boolean flag.

Example body

{
  "name": "\u2026",
  "zone": "\u2026",
  "zoneId": "\u2026",
  "scansPerMin": "\u2026",
  "acceptedPct": "\u2026",
  "rejectedPct": "\u2026",
  "avgLatencyMs": "\u2026",
  "queueEstimate": "\u2026",
  "status": "\u2026",
  "maxScansPerMin": "\u2026",
  "active": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/events/:eventId/access/gates

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`name`	body	Y	Display name (min 1).
`zone`	body	Y	Text field (min 1).
`zoneId`	body	Y	Access-control zone identifier (min 1).
`scansPerMin`	body	N	Numeric value.
`acceptedPct`	body	N	Numeric value.
`rejectedPct`	body	N	Numeric value.
`avgLatencyMs`	body	N	Numeric value.
`queueEstimate`	body	N	Numeric value.
`status`	body	N	Lifecycle status for the resource.
`maxScansPerMin`	body	N	Numeric value.
`active`	body	N	Boolean flag.

Example body

{
  "name": "\u2026",
  "zone": "\u2026",
  "zoneId": "\u2026",
  "scansPerMin": "\u2026",
  "acceptedPct": "\u2026",
  "rejectedPct": "\u2026",
  "avgLatencyMs": "\u2026",
  "queueEstimate": "\u2026",
  "status": "\u2026",
  "maxScansPerMin": "\u2026",
  "active": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

DELETE /api/events/:eventId/access/gates/:id

Remove or deactivate this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`id`	path	Y	Path parameter identifying the resource.
`label`	body	Y	Text field (min 1).
`gateId`	body	Y	Access-control gate identifier (min 1).
`gate`	body	Y	Text field (min 1).
`scannerId`	body	Y	Text field (min 1).
`battery`	body	N	Numeric value.
`status`	body	N	Lifecycle status for the resource.
`lastSeen`	body	N	Text field.
`version`	body	N	Text field.
`active`	body	N	Boolean flag.

Example body

{
  "label": "\u2026",
  "gateId": "\u2026",
  "gate": "\u2026",
  "scannerId": "\u2026",
  "battery": "\u2026",
  "status": "\u2026",
  "lastSeen": "\u2026",
  "version": "\u2026",
  "active": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

PATCH /api/events/:eventId/access/gates/:id

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`id`	path	Y	Path parameter identifying the resource.
`label`	body	Y	Text field (min 1).
`gateId`	body	Y	Access-control gate identifier (min 1).
`gate`	body	Y	Text field (min 1).
`scannerId`	body	Y	Text field (min 1).
`battery`	body	N	Numeric value.
`status`	body	N	Lifecycle status for the resource.
`lastSeen`	body	N	Text field.
`version`	body	N	Text field.
`active`	body	N	Boolean flag.

Example body

{
  "label": "\u2026",
  "gateId": "\u2026",
  "gate": "\u2026",
  "scannerId": "\u2026",
  "battery": "\u2026",
  "status": "\u2026",
  "lastSeen": "\u2026",
  "version": "\u2026",
  "active": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/events/:eventId/access/incidents

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

PATCH /api/events/:eventId/access/lockdown

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/events/:eventId/access/rules

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`key`	body	N	Text field (min 1).
`id`	body	Y	Request field. See Zod schema in the route module for constraints.
`enabled`	body	Y	Request field. See Zod schema in the route module for constraints.
`name`	body	Y	Display name.
`description`	body	Y	Request field. See Zod schema in the route module for constraints.
`bullets`	body	Y	Request field. See Zod schema in the route module for constraints.
`_id`	body	Y	Request field. See Zod schema in the route module for constraints.
`key`	body	Y	Request field. See Zod schema in the route module for constraints.
`enabled`	body	Y	Request field. See Zod schema in the route module for constraints.
`confirmationCode`	body	Y	Text field (min 1).
`gateId`	body	Y	Access-control gate identifier (min 1).
`deviceId`	body	N	Gate or POS device identifier.
`scannerId`	body	N	Text field.
`supervisorOverride`	body	N	Boolean flag.
`overrideReason`	body	N	Text field.
`offlineMode`	body	N	Boolean flag.

Example body

{
  "key": "\u2026",
  "id": "\u2026",
  "enabled": "\u2026",
  "name": "\u2026",
  "description": "\u2026",
  "bullets": "\u2026",
  "_id": "\u2026",
  "confirmationCode": "\u2026",
  "gateId": "\u2026",
  "deviceId": "\u2026",
  "scannerId": "\u2026",
  "supervisorOverride": "\u2026",
  "overrideReason": "\u2026",
  "offlineMode": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/events/:eventId/access/rules

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`key`	body	N	Text field (min 1).
`id`	body	Y	Request field. See Zod schema in the route module for constraints.
`enabled`	body	Y	Request field. See Zod schema in the route module for constraints.
`name`	body	Y	Display name.
`description`	body	Y	Request field. See Zod schema in the route module for constraints.
`bullets`	body	Y	Request field. See Zod schema in the route module for constraints.
`_id`	body	Y	Request field. See Zod schema in the route module for constraints.
`key`	body	Y	Request field. See Zod schema in the route module for constraints.
`enabled`	body	Y	Request field. See Zod schema in the route module for constraints.
`confirmationCode`	body	Y	Text field (min 1).
`gateId`	body	Y	Access-control gate identifier (min 1).
`deviceId`	body	N	Gate or POS device identifier.
`scannerId`	body	N	Text field.
`supervisorOverride`	body	N	Boolean flag.
`overrideReason`	body	N	Text field.
`offlineMode`	body	N	Boolean flag.

Example body

{
  "key": "\u2026",
  "id": "\u2026",
  "enabled": "\u2026",
  "name": "\u2026",
  "description": "\u2026",
  "bullets": "\u2026",
  "_id": "\u2026",
  "confirmationCode": "\u2026",
  "gateId": "\u2026",
  "deviceId": "\u2026",
  "scannerId": "\u2026",
  "supervisorOverride": "\u2026",
  "overrideReason": "\u2026",
  "offlineMode": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

DELETE /api/events/:eventId/access/rules/:id

Remove or deactivate this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`id`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

PATCH /api/events/:eventId/access/rules/:id

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`id`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/events/:eventId/access/scan

Process a gate scan against the event’s access rules.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/events/:eventId/access/scanner-config

Process a gate scan against the event’s access rules.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/events/:eventId/access/scans

Process a gate scan against the event’s access rules.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/events/:eventId/access/stats

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/events/:eventId/access/terminal-bootstrap

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/events/:eventId/access/zones

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`name`	body	Y	Display name (min 1).
`capacity`	body	Y	Maximum tickets or seats (min 0).
`color`	body	Y	Text field (min 1).
`active`	body	N	Boolean flag.

Example body

{
  "name": "\u2026",
  "capacity": 0,
  "color": "\u2026",
  "active": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/events/:eventId/access/zones

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`name`	body	Y	Display name (min 1).
`capacity`	body	Y	Maximum tickets or seats (min 0).
`color`	body	Y	Text field (min 1).
`active`	body	N	Boolean flag.

Example body

{
  "name": "\u2026",
  "capacity": 0,
  "color": "\u2026",
  "active": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

DELETE /api/events/:eventId/access/zones/:id

Remove or deactivate this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`id`	path	Y	Path parameter identifying the resource.
`name`	body	Y	Display name (min 1).
`zone`	body	Y	Text field (min 1).
`zoneId`	body	Y	Access-control zone identifier (min 1).
`scansPerMin`	body	N	Numeric value.
`acceptedPct`	body	N	Numeric value.
`rejectedPct`	body	N	Numeric value.
`avgLatencyMs`	body	N	Numeric value.
`queueEstimate`	body	N	Numeric value.
`status`	body	N	Lifecycle status for the resource.
`maxScansPerMin`	body	N	Numeric value.
`active`	body	N	Boolean flag.

Example body

{
  "name": "\u2026",
  "zone": "\u2026",
  "zoneId": "\u2026",
  "scansPerMin": "\u2026",
  "acceptedPct": "\u2026",
  "rejectedPct": "\u2026",
  "avgLatencyMs": "\u2026",
  "queueEstimate": "\u2026",
  "status": "\u2026",
  "maxScansPerMin": "\u2026",
  "active": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

PATCH /api/events/:eventId/access/zones/:id

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`id`	path	Y	Path parameter identifying the resource.
`name`	body	Y	Display name (min 1).
`zone`	body	Y	Text field (min 1).
`zoneId`	body	Y	Access-control zone identifier (min 1).
`scansPerMin`	body	N	Numeric value.
`acceptedPct`	body	N	Numeric value.
`rejectedPct`	body	N	Numeric value.
`avgLatencyMs`	body	N	Numeric value.
`queueEstimate`	body	N	Numeric value.
`status`	body	N	Lifecycle status for the resource.
`maxScansPerMin`	body	N	Numeric value.
`active`	body	N	Boolean flag.

Example body

{
  "name": "\u2026",
  "zone": "\u2026",
  "zoneId": "\u2026",
  "scansPerMin": "\u2026",
  "acceptedPct": "\u2026",
  "rejectedPct": "\u2026",
  "avgLatencyMs": "\u2026",
  "queueEstimate": "\u2026",
  "status": "\u2026",
  "maxScansPerMin": "\u2026",
  "active": "\u2026"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

Lock this page again

Access control · 23 methods · October 2026

Resolve this before you come in.

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data