Measure MapAPI
Help CenterGet an API key

Create a project for a person

POST/users/{uid}/projects/new
projects:write EnterpriseOpen Guest
Creates a project in the account of a member of your organisation, or in your own when uid is your account's ID. The project is created view only, so it can be embedded straight away.

Path parameters

  • uidstringrequired
    The ID of a member of your organisation, or your own account's ID.

Request body application/json

Fields of PersonProjectCreate:

  • namestring
  • descriptionstring
  • comments_enabledboolean
  • default_product_idstring
    A product of the catalogue that new shapes start with.
  • parentIdstring
    A folder the person owns or is a member of.
  • membersarray of string
    Accounts of your organisation that can open the project.
    at most 200 items

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.

400invalid_uidThe person's ID in the path is missing or blank.
400request_body_emptyThe request needs a JSON body and none was sent.
401unauthorized_actionThe item is not on your account or your members', the request came from a web page on a website the key does not allow, or the action is not allowed for this person.
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.
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/users/m3K8qZxLpV4NrT2w/projects/new

Fill in your API key to send.

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