GEgetmaintainx
Locations

Create new location

Changed on
post/locations

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

namestring required
descriptionstring nullable
addressstring nullable

Postal address of the location

barcodestring nullable

String encoded barcode

parentIdinteger nullable

ID of the parent location

extraFieldsobject

Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Department")

vendorIdsnumber[]

Vendor IDs

externalIdstring nullable

External ID for this location, unique per organization.

Example request

{
  "name": "Warehouses",
  "description": "The warehouse where we store the forklifts",
  "address": "1090 main street, Franklin",
  "barcode": "BWFPBNRHAW54CG",
  "parentId": 852,
  "extraFields": {
    "Department": "Electrical"
  },
  "vendorIds": [
    2
  ],
  "externalId": "ext-location-001"
}

Response

Successfully created location

idinteger required

Global ID of the location

Example response

{
  "id": 963
}

Changes

  • 222e6fad7c1fRevision changes
    • breaking

      removed the media type application/octet-stream from the request body

    • info

      added the new optional header request parameter x-organization-id

    • info

      added the new optional query request parameter skipWebhook

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status