Measure MapAPI
Help CenterGet an API key

Create a project

POST/projects/new
projects:write EnterpriseOpen Guest

Creates a project in your own account.

On Open Guest, a project created with the access level open_guest is a guest project: it counts towards your Open Guest usage and budget like one started from your guest link, and its guest details are kept with it. Guest projects made with a sandbox key are never counted or billed.

Request body application/json

Fields of ProjectCreate:

  • namestring
    The project's name.
  • descriptionstring
  • access_levelstring
    private when left out. open_guest only on an Open Guest plan, where it makes a billed guest project.
    One ofprivateview_onlypublicopen_guest
  • comments_enabledboolean
    Allow comments on the map. Always on for guest projects.
  • default_product_idstring
    A product of your catalogue that new shapes start with. Ignored when it is archived or hidden.
  • parentIdstring
    A folder of yours to file it in; it takes on the folder's members.
  • membersarray of string
    Accounts of your organisation that can open the project.
    at most 200 items
  • guestobject
    The guest's contact details, for an Open Guest project. Each is optional.

Responses

  • Project:

    • typestringrequired
      Always"project"
    • idstringrequired
      The project's ID.
    • creatorUidstringrequired
      The account that owns the project.
    • folderIdstringor null
      The folder it is filed in; empty or absent at the top level.
    • namestringrequired
    • descriptionstring
    • createdOninteger(int64)required
      When it was created, in milliseconds since 1 January 1970 (UTC).
    • thumbnailUrlstring(uri)
      A picture of the project's map, when one has been drawn.
    • totalPolygonsinteger
      How many areas and lines it holds.
    • totalSpotsinteger
      How many spots it holds.
    • membersarray of string
      The accounts that can open it, its owner included.
    • commentsEnabledboolean
      Whether comments can be left on its map.
    • defaultProductIdstring
      The product new shapes start with.

Errors

A failed request answers with one of these, in an Error body.

400request_body_emptyThe request needs a JSON body and none was sent.
402budget_limit_reachedOpen Guest. Your budget limit for this billing period is reached, so no more guest projects are started until the next one or until you raise it.
403insufficient_scopeThe key does not have the access this endpoint needs. Create a key with that access.
403invalid_api_keyNo key was sent in the Authorization header, or the key is unknown, revoked, or past the time it kept working after being replaced.
403invalid_subscriptionYour plan has no API access. The API is part of the Enterprise and Open Guest plans.
403subscription_expiredYour subscription is not active. Update your payment method in the app.

Try it

This key is

The key stays in this tab and goes only to the API. Use a sandbox key while you try things: requests are real, and what they change is changed.

POST https://api.measuremaponline.com/api/v1/projects/new

Fill in your API key to send.

As a cURL command
Shell
curl -X POST 'https://api.measuremaponline.com/api/v1/projects/new' \
  -H "Authorization: $MMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "14 Harbour Road",
  "description": "Front and back lawns, quote by Friday",
  "access_level": "view_only",
  "comments_enabled": true,
  "parentId": "fld_8Jk2LmQ4"
}'