Skip to main content
PUT
/
entities
/
{id}
Update Entity Properties
curl --request PUT \
  --url https://api.example.com/entities/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "properties": {},
  "externalRefs": [
    {
      "external_id": "<string>",
      "provider": "<string>"
    }
  ]
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "entity": "entity",
    "organization_id": "<string>",
    "collection_id": "<string>",
    "attributes": {},
    "version": 1,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

id
string
required

Body

application/json
properties
object
externalRefs
object[]

Response

200 - application/json

The updated entity

success
boolean
data
object