Skip to main content
PUT
/
objects
/
{objectId}
Update Object
curl --request PUT \
  --url https://api.g2cplatform.com/v2/objects/{objectId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "action": "update",
  "name": "<string>",
  "description": "<string>",
  "summary": "<string>",
  "owner": "<string>",
  "eventDescription": "<string>",
  "performedBy": "<string>",
  "metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "<string>",
  "name": "<string>",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "summary": "<string>",
  "owner": "<string>",
  "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subcategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "blockchain": {
    "txId": "<string>",
    "lastTxId": "<string>",
    "eventCount": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

API key for authenticating requests. Include in X-API-Key header.

Path Parameters

​
objectId
string<uuid>
required

Object identifier

Body

application/json
​
action
enum<string>
required

Type of action being performed on the object

Available options:
update,
transfer,
repair,
report_stolen
​
name
string
Required string length: 2 - 200
​
description
string
Maximum string length: 1000
​
summary
string
Maximum string length: 500
​
owner
string

New owner (required for transfer action)

Maximum string length: 100
​
eventDescription
string

Description of the event being recorded

Maximum string length: 1000
​
performedBy
string

Person or system performing the action

Maximum string length: 100
​
metadata
object

Response

Object updated successfully

​
id
string<uuid>
required
​
externalId
string
required
​
name
string
required
​
status
enum<string>
required
Available options:
active,
inactive,
stolen,
transferred,
archived
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
description
string
​
summary
string
​
owner
string
​
categoryId
string<uuid>
​
subcategoryId
string<uuid>
​
metadata
object
​
blockchain
object