org-nodes

Bulk-create locations

Creates up to 200 locations in a single call, for example to paste in a full location list at fleet setup. Send parentId and either a list of names or a list of units, each with a name and an optional time zone, town, Location ID and parent Location ID, so one list can hold regions and the stores under them. Empty or repeated names, and Location IDs already in use, are skipped, so the same list can safely be submitted again. Requires the create-location permission at the parent location.

Notes.

  • Idempotent: sending the same list again creates nothing new and lists every row in skipped.
post/v1/org-nodes/bulk

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/org-nodes/bulk
  • Auth: HTTP bearer

Request body

parentIdstring required

The location the new ones go under (unless a row names its own parent).

namesstring[]

Location names. Use this or units.

paysForItselfboolean

Every new location pays for itself before it goes live. Defaults to the account setting newLocationsPayFirst; choosing against it needs billing.edit at the workspace root.

Response

Success.

Example response

{
  "data": {
    "created": [
      {
        "id": "on_4d5e6f7a8b9c0d1e"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.