Delete

POST 
/api

Delete an entity. May also automatically delete related entities to maintain integrity.

Request

application/json

Body

array

required

• Array [

action Actionrequired

Possible values: [delete]

entity_type Entity Typerequired

entity_key

object

required

anyOf

MOD1

string

MOD2

Array [

string

]

metadata

object

property name* any

• ]

Responses

200

Successful Response

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Messagerequired

type Error Typerequired

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...