org-nodes

Create a location

Creates a new location under a parent location. Provide name, parentId, and an optional kind. To create many locations at once, use the bulk-create operation instead.

post/v1/org-nodes

Request

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

Request body

namestring required

Location name.

parentIdstring

Parent location; omit to place it directly under the workspace root.

externalIdstring

Your own location code; must be unique in the workspace.

timezonestring

IANA zone, e.g. Europe/London.

isSpaceboolean

Owner-only: create a child workspace (franchise).

billingOwnerNodeIdstring

With isSpace: the ancestor workspace that pays.

screenLimitinteger

Owner-only, advisory.

tierinteger

Owner-only. Defaults to 2.

billingunknown
featureOverridesunknown
paysForItselfboolean

The location pays for its own screens and stays on the hold card until it adds a card. Defaults to the account setting newLocationsPayFirst. Choosing against that default needs billing.edit at the workspace root. Brix billing only (409 otherwise).

Response

Success.

Example response

{
  "data": {
    "id": "on_4d5e6f7a8b9c0d1e"
  }
}

Changes

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