Entities

deleteEntity

Deletes an Entity

Activity

If no activity_id query parameter is provided, implicitly creates Activity of type EntityDeleted

Deletion Mode

All entities are soft deleted by default. To force an actual deletion from the system, provide purge:true to delete the entity and all its activity history permanently.

delete/v1/entity/{slug}/{id}

Request

  • Base URL
    https://entity.sls.epilot.io
  • URL
    https://entity.sls.epilot.io/v1/entity/{slug}/{id}
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-id

Path parameters

slugstring required

URL-friendly identifier for the entity schema

Example:contact

Entity Type

idstring uuid required

Entity id

Query parameters

string ulid

See https://github.com/ulid/spec

OR
'' | 'null' nullable
Example:01F130Q52Q6MWSNS8N2AVXV4JN

Activity to include in event feed

purgeboolean

Permanently deletes the entity when set to true

Response

Success

Changes

No recorded changes to this operation across all 18 revisions of this API.