Docs

Change an asset

Preview· P9
PATCH
/assets/{asset_id}

Name the version you read: a stale one is version_stale (409), and nothing changes.

Scope: assets:write

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people.
agoo_pk_test_Publishable key, test modeAs above, in test mode
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs above, on any level: it reads the business's reviews and checks every write without saving it
agoo_ck_live_Check API key, live mode, for a Check API partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs above, answering only the published test values, never billed

Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

Scope: assets:write

Path Parameters

asset_id*string
Match^asset_[0-7][0-9a-hjkmnp-tv-z]{25}$

Query Parameters

version*integer

The version you read.

Range1 <= value

Header Parameters

Idempotency-Key*string

A UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the original response instead of acting twice. While the first request is still running, a retry returns conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.

Formatuuid

Request Body

application/json
  1. body

Adds or changes an asset. To empty a field, name it in clear.

name?string
Lengthlength <= 160
category_id?string
tag?string
Lengthlength <= 40
barcode?string
Lengthlength <= 80
serial?string
Lengthlength <= 120
imei?string
Lengthlength <= 40
site_id?string

When adding. To change where something is, use its move.

room?string
Lengthlength <= 120
supplier?string
Lengthlength <= 160
value_minor?integer

Whole minor units. Needs assets.value_read.

Range0 <= value
value_currency?string
purchase_date?string
Formatdate
warranty_until?string
Formatdate
insurance_until?string
Formatdate
maintenance_due_on?string
Formatdate
licence_until?string
Formatdate
inspect_every_days?integer
Range1 <= value <= 3660
condition?string
Value in"new""good""fair""poor""damaged"
owner_person_id?string

Who reminders go to. Nobody named: whoever manages assets.

shared?boolean

Staff may check it out for themselves by scanning it.

legal_entity_id?string
photo_file_ids?array<string>
Itemsitems <= 12
custom?

The category's own fields.

notes?string
Lengthlength <= 2000
clear?array<string>

Fields to empty.

Itemsitems <= 20

Response Body

The asset.

application/json
  1. response
id*string
name*string
tag*string
barcode?string
serial?string
imei?string
status*string
Value in"in_stock""assigned""in_repair""lost""retired"
condition*string
Value in"new""good""fair""poor""damaged"
category*
site?
room?string
supplier?string
purchase_date?string
Formatdate
warranty_until?string
Formatdate
insurance_until?string
Formatdate
shared?boolean
holder?
value_minor?integer

Whole minor units, with assets.value_read.

value_currency?string
custom?
version*integer
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
curl -X PATCH 'https://api.agoohq.com/v1/assets/string?version=1' \  -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "name": "string",  "tag": "string",  "barcode": "string",  "serial": "string",  "imei": "string",  "status": "in_stock",  "condition": "new",  "category": {    "id": "string",    "name": "string",    "is_ppe": true  },  "site": {    "id": "string",    "name": "string"  },  "room": "string",  "supplier": "string",  "purchase_date": "2019-08-24",  "warranty_until": "2019-08-24",  "insurance_until": "2019-08-24",  "shared": true,  "holder": {    "id": "string",    "asset_id": "string",    "holder_kind": "person",    "person": {      "id": "string",      "name": "string"    },    "site": {      "id": "string",      "name": "string"    },    "team": {      "id": "string",      "name": "string"    },    "pool_name": "string",    "condition_out": "new",    "expected_return_on": "2019-08-24",    "assigned_at": "2019-08-24T14:15:22Z",    "ack_state": "not_needed",    "returned_at": "2019-08-24T14:15:22Z",    "condition_in": "new",    "version": 0  },  "value_minor": 0,  "value_currency": "string",  "custom": {},  "version": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}