Update device's meta information (assignment info and location)

patch

https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

number

required

deviceId

number

required

Body Params

status

string

enum

The status of the device. If IN_STOCK status is set, the device will be unassigned and the assignment start/end date will be cleared. If DECOMMISSIONED status is set, the assignment dates will be cleared but the last assigned user will be preserved for audit purposes.

Allowed:

peopleId

number | null

The people ID to assign the device to. If null, the device will be unassigned. Device that has IN_STOCK status can't be assigned to a person. For DECOMMISSIONED devices, the last assigned user is preserved for audit purposes.

assignmentStartDate

date | null

The date the device is assigned to the person. Device that has IN_STOCK or DECOMMISSIONED can't have assignment start date

assignmentEndDate

date | null

The date the device assignment ends. Device that has IN_STOCK or DECOMMISSIONED can't have assignment end date

location1

string

Primary location information for the device

location2

string

Secondary location information for the device

comment

string | null

Comment or reason for the assignment/status change

Responses

418

The feature isn't available for the organization. Please contact the support team.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200