/programs/{program_id}/frameworks/{framework_id}Delete framework
Deletes the specified framework from a program and places all integrations into an idle state, breaking existing client connections.
The deletion completes after all operations finish. You cannot delete a program's root or default framework, or a framework that has a child framework. A program must have at least one framework.
By default, deleted frameworks can be recovered within a 7-day grace period.
Use the hard_delete parameter to permanently delete the framework immediately.
For related information, see Manage frameworks.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID" \
-X DELETE \
-H "Authorization: Bearer $OPTITECH_API_KEY"Every field below is optional. An empty body works too.
optitech branches delete <program_id>Parameters
program_idThe OptiTech program ID
framework_idThe framework ID
hard_deleteIf true, the framework is permanently deleted immediately without a recovery window. If false (default), the framework can be recovered within 7 days via the recover endpoint.
This parameter is part of the Framework Recovery feature, which is in preview and not available to all users.
Response
200Deleted the specified framework
Errors
General error
This endpoint can return the standard OptiTech API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.