---
updatedAt: 2025-09-24T23:56:11.000Z
agentTools:
  projectIndex: https://docs.noonlight.com/llms.txt
---

# Create alarm

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Dispatch API",
    "x-logo": {
      "url": "https://lh3.googleusercontent.com/gHJckPgSU8l_52874pgKeGhG12ARZVOA3ZKGJttZjU7X-fR88vJju_k2JtYb4vI__GVB",
      "altText": "Noonlight logo"
    }
  },
  "servers": [
    {
      "url": "https://api-sandbox.noonlight.com/dispatch/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "paths": {
    "/alarms": {
      "post": {
        "summary": "Create alarm",
        "tags": [
          "Alarms"
        ],
        "security": [
          {
            "bearerAuth": [
              "write:alarm"
            ]
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Name of alarm owner"
                  },
                  "phone": {
                    "type": "string",
                    "description": "15555555555"
                  },
                  "pin": {
                    "type": "string",
                    "example": 0,
                    "description": "If provided, pin used to cancel the alarm."
                  },
                  "owner_id": {
                    "type": "string",
                    "description": "ID associated with the owner of the alarm. Will be created if not provided."
                  },
                  "location": {
                    "type": "object",
                    "description": "Either an address or coordinates must be provided",
                    "additionalProperties": false,
                    "properties": {
                      "details": {
                        "type": "object",
                        "additionalProperties": false,
                        "description": "Optional details about the location",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "business"
                            ],
                            "description": "Type of location. If provided, must be set to `business`."
                          }
                        },
                        "oneOf": [
                          {
                            "properties": {
                              "zone": {
                                "type": "string",
                                "description": "Zone identifier within the business location"
                              },
                              "name": {
                                "type": "string",
                                "description": "Name of the location"
                              }
                            }
                          }
                        ]
                      }
                    },
                    "oneOf": [
                      {
                        "type": "object",
                        "properties": {
                          "address": {
                            "type": "object",
                            "additionalProperties": false,
                            "properties": {
                              "line1": {
                                "type": "string"
                              },
                              "line2": {
                                "type": "string"
                              },
                              "city": {
                                "type": "string"
                              },
                              "state": {
                                "type": "string",
                                "enum": [
                                  "AL",
                                  "AK",
                                  "AZ",
                                  "AR",
                                  "AA",
                                  "AE",
                                  "AP",
                                  "CA",
                                  "CO",
                                  "CT",
                                  "DE",
                                  "DC",
                                  "FL",
                                  "GA",
                                  "HI",
                                  "ID",
                                  "IL",
                                  "IN",
                                  "IA",
                                  "KS",
                                  "KY",
                                  "LA",
                                  "ME",
                                  "MD",
                                  "MA",
                                  "MI",
                                  "MN",
                                  "MS",
                                  "MO",
                                  "MT",
                                  "NE",
                                  "NV",
                                  "NH",
                                  "NJ",
                                  "NM",
                                  "NY",
                                  "NC",
                                  "ND",
                                  "OH",
                                  "OK",
                                  "OR",
                                  "PA",
                                  "RI",
                                  "SC",
                                  "SD",
                                  "TN",
                                  "TX",
                                  "UT",
                                  "VT",
                                  "VA",
                                  "WA",
                                  "WV",
                                  "WI",
                                  "WY"
                                ]
                              },
                              "zip": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "line1",
                              "city",
                              "state",
                              "zip"
                            ]
                          }
                        }
                      },
                      {
                        "type": "object",
                        "properties": {
                          "coordinates": {
                            "type": "object",
                            "properties": {
                              "lat": {
                                "type": "number",
                                "minimum": -90,
                                "maximum": 90
                              },
                              "lng": {
                                "type": "number",
                                "minimum": -180,
                                "maximum": 180
                              },
                              "accuracy": {
                                "type": "integer",
                                "minimum": 0
                              }
                            },
                            "additionalProperties": false,
                            "required": [
                              "lat",
                              "lng",
                              "accuracy"
                            ]
                          }
                        }
                      }
                    ]
                  },
                  "workflow": {
                    "type": "object",
                    "additionalProperties": false,
                    "description": "Optional workflow ID. This will be provided to you by the Noonlight team for certain use cases.",
                    "properties": {
                      "id": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "id"
                    ]
                  },
                  "services": {
                    "type": "object",
                    "additionalProperties": false,
                    "description": "Services to be requested. If provided, at least one service must be set to `true`.",
                    "properties": {
                      "police": {
                        "type": "boolean"
                      },
                      "fire": {
                        "type": "boolean"
                      },
                      "medical": {
                        "type": "boolean"
                      },
                      "other": {
                        "type": "boolean"
                      }
                    },
                    "not": {
                      "properties": {
                        "police": {
                          "enum": [
                            false
                          ]
                        },
                        "fire": {
                          "enum": [
                            false
                          ]
                        },
                        "medical": {
                          "enum": [
                            false
                          ]
                        },
                        "other": {
                          "enum": [
                            false
                          ]
                        }
                      }
                    }
                  },
                  "instructions": {
                    "type": "object",
                    "additionalProperties": false,
                    "description": "Instructions relayed to the dispatchers. Currently, the only allowed type is entry.",
                    "properties": {
                      "entry": {
                        "description": "Information needed to access the location of the alarm ex. gate code",
                        "type": "string"
                      }
                    },
                    "required": [
                      "entry"
                    ]
                  }
                },
                "required": [
                  "phone",
                  "name",
                  "location"
                ]
              },
              "examples": {
                "Address": {
                  "value": {
                    "name": "John Smith",
                    "phone": "15554440003",
                    "pin": "4242",
                    "location.address": {
                      "line1": "911 Washington Ave",
                      "line2": "Suite 230",
                      "city": "St. Louis",
                      "state": "MO",
                      "zip": "63101"
                    }
                  }
                },
                "Coordinates": {
                  "value": {
                    "name": "John Smith",
                    "phone": "15555555555",
                    "pin": "0000",
                    "location": {
                      "coordinates": {
                        "lat": 38.6314442,
                        "lng": -90.1953765,
                        "accuracy": 5
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string"
                    },
                    "created_at": {
                      "type": "string",
                      "format": "date"
                    },
                    "owner_id": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```