/APIs & SDKs/Frameworks/Set framework as default
POST/programs/{program_id}/frameworks/{framework_id}/set_as_default

Set framework as default

Sets the specified framework as the program's default framework. The default designation is automatically removed from the previous default framework. For more information, see Manage frameworks.

Markdown for AI context

Quick start

REST API - curl
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID/set_as_default" \
  -X POST \
  -H "Authorization: Bearer $OPTITECH_API_KEY"

Every field below is optional. An empty body works too.

Also available in
optitech branches set-default <id|name>

Parameters

Program ID
program_id
string

The OptiTech program ID

Framework ID
framework_id
string

The framework ID

Response

200

Updated the specified framework

Depth

Errors

default

General error

This endpoint can return the standard OptiTech API error response.

Response fields

  • message Required. Human-readable error message.
  • code Required. Machine-readable error code.
  • request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

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.

Was this page helpful?

On this page

Copy neon init command