[beta] Create a maintenance site

Creates a maintenance site for the organization. Exactly one of placeIds or customAddress must be set.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Maintenance Sites under the Work Orders category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a MaintenanceSite

customAddress
object

CreateMaintenanceSiteEntityMaintenanceSiteMaintenanceSiteCustomAddressInput object

string

Description of the maintenance site.

externalIds
array of objects

Customer-supplied external identifiers for the site, interchangeable with id in filters. Only included in the response when includeExternalIds is set.

externalIds
string
required

Name of the maintenance site. Org-unique.

placeIds
array of strings

Places this site is linked to. Mutually exclusive with customAddress. At most one entry is accepted today, though the field is an array to allow for future expansion.

placeIds
string
required

Org-unique 3-character code for the site, used to generate inventory batch numbers.

string
enum
required

Type of maintenance site, for example central warehouse, maintenance shop, or yard/onsite. Valid values: Unknown, CentralWarehouse, MaintenanceShop, MobileServiceVehicle, YardOnsite, Consignment, Other

Allowed:
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json