POST
/
groups
curl --request POST \
  --url https://app.planpoint.io/api/groups \
  --header 'Authorization: <api-key>'
{
  "_id": "objectId",
  "user": "objectId",
  "name": "<string>",
  "websiteURL": "<string>",
  "showAvailableFirst": false,
  "projects": [
    "objectId"
  ],
  "namespace": "<string>",
  "hostName": "<string>",
  "groupLang": "en",
  "linkBehavior": "Planpoint",
  "accentColor": "<string>",
  "groupImageUrl": "<string>",
  "groupSVGUrl": "<string>",
  "svgGroupId": "<string>",
  "address": "<string>",
  "lon": -93.75940812944687,
  "lat": 43.75940812944687,
  "zoomLevel": 0,
  "administrators": [
    "objectId"
  ],
  "editors": [
    "objectId"
  ],
  "invites": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "level": "<string>"
    }
  ],
  "perimeter": "<string>",
  "markerImageUrl": "<string>",
  "targetMarker": "<string>",
  "mapStyle": "Light",
  "mapPointColor": "<string>",
  "showAllUnits": true,
  "showPrices": true,
  "initialView": "List",
  "unitImageOnGrid": "Unit Plan",
  "pricesStartingAt": false,
  "showTaxes": true,
  "priceBeforeTax": true,
  "showAvailability": true,
  "hideSold": true,
  "deliveryDates": true,
  "internalURL": "<string>",
  "alternativeCovers": [
    "<string>"
  ],
  "hideArea": false,
  "theme": "<string>",
  "showBranding": true,
  "showPriceFilter": true,
  "showAreaFilter": true,
  "showFloorOverview": false,
  "colorBase": "<string>",
  "colorAccent": "<string>",
  "colorHover": "<string>",
  "colorButton": "<string>",
  "colorButtonText": "<string>",
  "colorText": "<string>"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
name
string

Name of the group

​
namespace
string

Namespace of the group

​
hostName
string

Hostname of the group

Response

200
application/json
Successful operation
​
_id
string

The unique identifier for the group.

Example:

"objectId"

​
user
string

Reference to the user who owns the group.

Example:

"objectId"

​
name
string

Name of the group.

​
websiteURL
string

URL of the group's website.

​
showAvailableFirst
boolean
default:false

Whether to prioritize showing available items first.

​
projects
string[]

ID of an associated project.

​
namespace
string

Namespace for the group.

​
hostName
string

Hostname of the group.

​
groupLang
string
default:en

Language setting for the group.

​
linkBehavior
string
default:Planpoint

Default link behavior.

​
accentColor
string

Accent color of the group.

​
groupImageUrl
string

URL of the group's image.

​
groupSVGUrl
string

URL of the group's SVG.

​
svgGroupId
string

SVG group identifier.

​
address
string

Physical address of the group.

​
lon
number

Longitude of the group location.

Example:

-93.75940812944687

​
lat
number

Latitude of the group location.

Example:

43.75940812944687

​
zoomLevel
number
default:0

Default map zoom level.

​
administrators
string[]

ID of an administrator user.

​
editors
string[]

ID of an editor user.

​
invites
object[]

List of invited users.

​
perimeter
string

Perimeter of the group area.

​
markerImageUrl
string

URL of the marker image.

​
targetMarker
string

Target marker identifier.

​
mapStyle
string
default:Light

Style of the map.

​
mapPointColor
string

Color of map points.

​
showAllUnits
boolean

Whether to display all units.

​
showPrices
boolean

Whether to display prices.

​
initialView
string
default:List

Initial view of the group.

​
unitImageOnGrid
string
default:Unit Plan

Image type shown on the grid.

​
pricesStartingAt
boolean
default:false

Whether to show prices starting at a certain value.

​
showTaxes
boolean

Whether to show taxes.

​
priceBeforeTax
boolean

Whether the price is shown before tax.

​
showAvailability
boolean

Whether to show availability.

​
hideSold
boolean

Whether to hide sold units.

​
deliveryDates
boolean

Whether to show delivery dates.

​
internalURL
string

Internal URL for the group.

​
alternativeCovers
string[]

List of alternative cover images.

​
hideArea
boolean
default:false

Whether to hide the area field.

​
theme
string

Theme of the group.

​
showBranding
boolean
default:true

Whether to show branding.

​
showPriceFilter
boolean
default:true

Whether to show the price filter.

​
showAreaFilter
boolean
default:true

Whether to show the area filter.

​
showFloorOverview
boolean
default:false

Whether to show the floor overview.

​
colorBase
string

Base color.

​
colorAccent
string

Accent color.

​
colorHover
string

Hover color.

​
colorButton
string

Button color.

​
colorButtonText
string

Button text color.

​
colorText
string

General text color.

Get GroupUpdate Group