FLflocksafety
Custom Hotlists

Add a batch of entries to a hotlist

Changed on

Add a batch of entries to the hotlist with the provided hotlistID. All entries will be normalized (O->0) and have whitespace trimmed. Duplicate entries will be ignored.

post/hotlists/{hotlistId}/entries/addBatch

Request

  • Base URL
    https://api.flocksafety.com/api/v3
  • URL
    https://api.flocksafety.com/api/v3/hotlists/{hotlistId}/entries/addBatch
  • Auth
    • OpenID Connect (https://login.flocksafety.com/.well-known/openid-configuration, scopes: custom-hotlists:write)
    • or OAuth 2
      Client credentials
      Token URL: https://api.flocksafety.com/oauth/token scopes: custom-hotlists:write

Path parameters

hotlistIdstring uuid required

hotlist uuid

Request body

Example request

{
  "entries": [
    {
      "note": {
        "message": "Vehicle observed at 5th and Main. Contact Det. Smith at 555-0123."
      }
    }
  ]
}

Response

The batch of hotlist entries was successfully normalized and created.

Example response

{
  "entries": [
    {
      "note": {
        "message": "Vehicle observed at 5th and Main. Contact Det. Smith at 555-0123."
      }
    }
  ]
}

Changes