Docs

Take an asset back

Preview· P9
POST
/asset-assignments/{assignment_id}/return

With its condition. Fires asset.returned. Returning one already returned changes nothing.

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

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

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
condition_in?string
Value in"new""good""fair""poor""damaged"
note?string
Lengthlength <= 500
photo_file_ids?array<string>
Itemsitems <= 6

Response Body

The hand-over.

application/json
  1. response
id*string
asset_id*string
holder_kind*string
Value in"person""site""team""pool"
person?
site?
team?
pool_name?string
condition_out*string
Value in"new""good""fair""poor""damaged"
expected_return_on?string
Formatdate
assigned_at*string
Formatdate-time
ack_state*string

Their signed acknowledgement of care. It never holds up the hand-over.

Value in"not_needed""not_asked""waiting""signed""declined""waived"
returned_at?string
Formatdate-time
condition_in?string
Value in"new""good""fair""poor""damaged"
version*integer
curl -X POST 'https://api.agoohq.com/v1/asset-assignments/string/return' \  -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \  -H 'Content-Type: application/json' \  -d '{}'
{  "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}