Skip to main content
POST
/
entities
Create Entity
curl --request POST \
  --url https://api.example.com/entities \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "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"
  }
}

Body

application/json
type
string
required
properties
object
required
externalRefs
object[]

Response

201 - application/json

The created entity

success
boolean
data
object