Delete an entity

View as Markdown
DELETE /api/v1/entities/{entity}

Permanently deletes an entity. It cannot be undone. Also immediately cancels any insurance policies connected with active jobs managed by the entity.

Path parameters

  • entity string Required

    The ID of the desired entity (e.g., en_Ah3tqYn).

Responses

  • 200 application/json

    A successfully deleted entity. Otherwise, this call returns an error, such as if the entity has already been deleted.

    Hide response attributes Show response attributes object
    • deleted boolean
    • deleted_at integer

      Unix timestamp (seconds since epoch) of when the entity was deleted.

    • id string

      The entity ID.

    • object string

      Default value is entity.
DELETE /api/v1/entities/{entity} 
curl \
 --request DELETE 'https://api.1099policy.com/api/v1/entities/en_Ah3tqYn'
Response examples (200) 
{
  "id": "en_Ah3tqYn",
  "object": "entity",
  "deleted": true,
  "deleted_at": 1640995200
}