Create Equipment

POST 
https://secure.fleetio.com/api/v1/equipment

Creates a new Equipment

Request

application/json

Body

namestringrequired
The name for this Equipment.
brandstring
The name of the brand which makes this Equipment.
modelstring
The model name of this Equipment.
serial_numberstring
The serial number of this Equipment.
type_idId (integer)required
Possible values: >= 1
status_idId (integer)required
Possible values: >= 1
group_idNullableId (integer)nullable
Possible values: >= 1
group_hierarchystring
A pipe delimited group hierarchy. Ex: "Level 1|Level 2|Level 3". Where Level 1 is the parent of Level 2, and 2 is the parent of 3. Any missing nodes in the hierarchy will be created.
purchase_vendor_idNullableId (integer)nullable
Possible values: >= 1
purchase_pricenumber
The price at which the Equipment was purchased.
purchase_datedate
We recommend using ISO-8601 formatted dates to avoid ambiguity.
Example: 2023-03-14
warranty_expiration_datedate
The date on which the Equipment warranty expires.
Example: 2023-03-14
purchase_commentsstring
Any comments about the purchase of this Equipment.
in_service_datedate
We recommend using ISO-8601 formatted dates to avoid ambiguity.
Example: 2023-03-14
estimated_service_lifeinteger
The estimated duration in months of the service life for this Equipment.
estimated_resale_pricenumber
The estimated resale price of this Equipment.
out_of_service_datedate
We recommend using ISO-8601 formatted dates to avoid ambiguity.
Example: 2023-03-14
linked_vehicle_idNullableId (integer)nullable
Possible values: >= 1
assignee_idNullableId (integer)nullable
Possible values: >= 1
default_imageurinullable
The default image URL for this Equipment.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
documents_attributes object[]
An array of one or more document objects to add to the record. Follow our Attaching Documents and Images guide to upload to our third party storage provider in order to obtain file_url.
Array [
namestring
The name to give the file which will be shown in the UI.
Possible values: <= 255 characters
file_urlstring
The URL obtained from our storage provider that points to the file.
Possible values: <= 255 characters
file_mime_typestring
The MIME type of the file. For example, application/pdf.
Possible values: <= 255 characters
file_namestring
The name of the file.
Possible values: <= 255 characters
file_sizeinteger
The size of the file in bytes.
]
images_attributes object[]
An array of one or more image objects to add to the record. Follow our Attaching Documents and Images guide to upload to our third party storage provider in order to obtain file_url.
Array [
namestring
The name to give the image which will be shown in the UI.
Possible values: <= 255 characters
file_urlstring
The URL obtained from our storage provider that points to the image.
Possible values: <= 255 characters
file_mime_typestring
The MIME type of the image. For example, image/png.
Possible values: <= 255 characters
file_namestring
The name of the image.
Possible values: <= 255 characters
file_sizeinteger
The size of the image file in bytes.
]

Responses

201

OK

Response Headers

application/json

Schema

Schema

idId (integer)required

Possible values: >= 1

created_atdate-timerequired

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-timerequired

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

account_idintegerrequired

The ID of the Account this Equipment belongs to.

namestringrequired

The name for this Equipment.

brandstringnullablerequired

The name of the brand which makes this Equipment.

modelstringnullablerequired

The model name of this Equipment.

serial_numberstringnullablerequired

The serial number of this Equipment.

equipment_type_idId (integer)required

Possible values: >= 1

equipment_status_idId (integer)required

Possible values: >= 1

group_idNullableId (integer)nullablerequired

Possible values: >= 1

purchase_vendor_idNullableId (integer)nullablerequired

Possible values: >= 1

purchase_price_centsnumbernullablerequired

The purchase price in cents.

purchase_datedatenullablerequired

The date on which the Equipment was purchased.

Example: 2023-03-14

warranty_expiration_datedatenullablerequired

The date on which the Equipment warranty expires.

Example: 2023-03-14

purchase_commentsstringnullablerequired

Any comments about the purchase of this Equipment.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

in_service_datedatenullablerequired

The date on which the Equipment was put into service.

Example: 2023-03-14

estimated_service_lifeintegernullablerequired

The estimated duration in months of the service life for this Equipment.

out_of_service_datedatenullablerequired

The estimated date on which the Equipment will be retired from service.

Example: 2023-03-14

archived_atdate-timenullablerequired

The date and time at which the Equipment was archived.

current_location_entry_idNullableId (integer)nullable

Possible values: >= 1

watchers_countintegerrequired

The number of users watching this Equipment.

watchable_optionsobject

bulk_watch_recordboolean

Whether or not to bulk watch this Equipment.

estimated_resale_price_centsintegernullable

The estimated resale price of this Equipment.

label_liststring[]

A list of any labels applied to this Equipment.

skip_automatic_watchers_callbacksboolean

Whether or not to skip automatic watchers callbacks on this Equipment.

comments_countintegerrequired

The number of Comments on this Equipment.

Possible values: >= 0

documents_countintegerrequired

The number of documents attached to this Equipment.

Possible values: >= 0

images_countintegerrequired

The number of images attached to this Equipment.

Possible values: >= 0

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "name": "string",
  "brand": "string",
  "model": "string",
  "serial_number": "string",
  "equipment_type_id": 0,
  "equipment_status_id": 0,
  "group_id": 0,
  "purchase_vendor_id": 0,
  "purchase_price_cents": 0,
  "purchase_date": "2023-03-14",
  "warranty_expiration_date": "2023-03-14",
  "purchase_comments": "string",
  "custom_fields": {},
  "in_service_date": "2023-03-14",
  "estimated_service_life": 0,
  "out_of_service_date": "2023-03-14",
  "archived_at": "2024-07-29T15:51:28.071Z",
  "current_location_entry_id": 0,
  "watchers_count": 0,
  "watchable_options": {},
  "bulk_watch_record": true,
  "estimated_resale_price_cents": 0,
  "label_list": [
    "string"
  ],
  "skip_automatic_watchers_callbacks": true,
  "comments_count": 0,
  "documents_count": 0,
  "images_count": 0
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

422

Unprocessable Entity

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

Example

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/equipment' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "name": "string",
  "brand": "string",
  "model": "string",
  "serial_number": "string",
  "type_id": 0,
  "status_id": 0,
  "group_id": 0,
  "group_hierarchy": "string",
  "purchase_vendor_id": 0,
  "purchase_price": 0,
  "purchase_date": "2023-03-14",
  "warranty_expiration_date": "2023-03-14",
  "purchase_comments": "string",
  "in_service_date": "2023-03-14",
  "estimated_service_life": 0,
  "estimated_resale_price": 0,
  "out_of_service_date": "2023-03-14",
  "linked_vehicle_id": 0,
  "assignee_id": 0,
  "default_image": "string",
  "custom_fields": {},
  "documents_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ],
  "images_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ]
}'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "name": "string",
  "brand": "string",
  "model": "string",
  "serial_number": "string",
  "type_id": 0,
  "status_id": 0,
  "group_id": 0,
  "group_hierarchy": "string",
  "purchase_vendor_id": 0,
  "purchase_price": 0,
  "purchase_date": "2023-03-14",
  "warranty_expiration_date": "2023-03-14",
  "purchase_comments": "string",
  "in_service_date": "2023-03-14",
  "estimated_service_life": 0,
  "estimated_resale_price": 0,
  "out_of_service_date": "2023-03-14",
  "linked_vehicle_id": 0,
  "assignee_id": 0,
  "default_image": "string",
  "custom_fields": {},
  "documents_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ],
  "images_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!