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

The response is of type object.