Deeply API Documentation main logoDeeply API Documentation main logo textDeeply API Documentation main logo text
User GuideServer API Reference
k

Quick Start

API Quick Start Guide
Authorization
Rate Limit

Architecture

Overall Architecture
Edge Server System

Events

Events
Event Categories
List Events
GET
Get An Event
GET

Live Events

Live Events
Listen Live Events
WebSocket

Edges

Edge Server
List Edge Servers
GET
Get An Edge Server
GET
Update Edge Server
PATCH

Microphones

Mic Device
List Mic Devices
GET
Get A Mic Device
GET
Update Mic Device
PATCH

Auth

Reissue Token
GET

© 2025 Deeply Inc.

Deeply Logo Icon

Deeply API Documentation

    1. reference
    2. Devices
    3. Update Device Info

    Update A Mic Device

    Update information for a specific microphone device by its ID

    PATCH
    /api/v1/mics/{mic_id}

    Description

    API to update information for a specific microphone device by its ID. Refer to the Mic Device Object for more details.

    Authentication

    Access Token is required via Bearer token authentication. Refer to the Authentication section for more details.

    Path Parameters

    Request Body

    Request Body Parameters

    Response

    {
      "data": {
        "id": "string",
        "name": "string",
        "edge_id": "string",
        "location": {
          "latitude": -90,
          "longitude": -180
        },
        "status": "active",
        "thresholds": {
          "string": 0.5
        },
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      }
    }

    Request Examples

    Run In Postman

    Update Device Name

    const response = await fetch('https://openapi.deeplyinc.com/api/v1/mics/mic_123', {
      method: 'PATCH',
      headers: {
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        "name": "New Device Name"
      })
    });
    
    const data = await response.json();

    Update Device Location

    const response = await fetch('https://openapi.deeplyinc.com/api/v1/mics/mic_123', {
      method: 'PATCH',
      headers: {
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        "location": {
          "latitude": 37.5665,
          "longitude": 126.978
        }
      })
    });
    
    const data = await response.json();

    Update Device Thresholds

    const response = await fetch('https://openapi.deeplyinc.com/api/v1/mics/mic_123', {
      method: 'PATCH',
      headers: {
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        "thresholds": {
          "screem_male": 0.5,
          "screem_female": 0.31,
          "breathing_heavily": 0.2
        }
      })
    });
    
    const data = await response.json();
    Get A Mic Device
    Reissue Token

    On this page

    DescriptionAuthenticationRequest BodyResponseRequest ExamplesUpdate Device NameUpdate Device LocationUpdate Device Thresholds
    mic_id
    required
    string
    name
    optional
    string
    host
    optional
    string
    location
    optional
    object
    status
    optional
    enum

    Enum Values:

    active
    inactive
    thresholds
    optional
    object

    Unique identifier of the microphone device

    New name for the device

    New host for the device (e.g. "192.168.1.100")

    New location information

    New status for the device. Could be active or inactive

    Detection threshold values for various sound events. Each threshold is a key-value pair where the value is a number between 0 and 1.