Sign in

v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB
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}

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