Delete Portal

DELETE 
/api/portals/deleteportal/:id

Tier: Internal — subject to change without notice.

Deletes a portal.

Deletion soft-deletes the portal's underlying Agent (freeing its licence); the portal row itself is not touched but is excluded from all queries once the Agent is deleted.

Request

Responses

200

Returns true.

400

The id does not resolve to a portal in the caller's organisation (NotFound), or the portal still has rules (InvalidOperation on field Rules) or devices (InvalidOperation on field Devices) attached.

401

Caller is not authenticated.

403

Caller does not have Delete permission on the Portal module.