Approves one Pending scheduled change to apply inside this change freeze when it comes due, with a reason.
const url = 'https://api.featureflip.io/api/v1/orgs/example/change-freezes/example/approvals';const options = { method: 'POST', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"scheduledChangeId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","reason":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.featureflip.io/api/v1/orgs/example/change-freezes/example/approvals \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "scheduledChangeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reason": "example" }'The
change must be in an environment the window covers; when it applies, its audit rows and webhooks are marked
pre-approved. The approval counts only while the approver is still an Owner or Admin. Requires Admin and the
Business plan or above (a lower plan is a 400 PLAN_FEATURE_UNAVAILABLE); approving the same change twice
is a 409. Supports the Idempotency-Key header.
Authorizations
Section titled “ Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “ Path Parameters ”Request Body
Section titled “ Request Body ”Approves one Pending scheduled change to apply inside the change freeze when it comes due, with a required
reason. The change must be in an environment the window covers. scheduledChangeId is required: a
missing or empty one is a 400 naming the field.
object
Example generated
{ "scheduledChangeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reason": "example"}Approves one Pending scheduled change to apply inside the change freeze when it comes due, with a required
reason. The change must be in an environment the window covers. scheduledChangeId is required: a
missing or empty one is a 400 naming the field.
object
Example generated
{ "scheduledChangeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reason": "example"}Approves one Pending scheduled change to apply inside the change freeze when it comes due, with a required
reason. The change must be in an environment the window covers. scheduledChangeId is required: a
missing or empty one is a 400 naming the field.
object
Example generated
{ "scheduledChangeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reason": "example"}Responses
Section titled “ Responses ”Created
A scheduled change that a person approved to land inside a change freeze. stands is whether the approval
counts right now: false once the approver is no longer an active Owner or Admin, and the window then holds or fails
the change as if it were not approved.
object
Example generated
{ "scheduledChangeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "flagId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "flagKey": "example", "environmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scheduledAtUtc": "2026-04-15T12:00:00Z", "reason": "example", "approvedByEmail": "example", "approvedAt": "2026-04-15T12:00:00Z", "stands": true}Headers
Section titled “ Headers ”The maximum number of requests permitted per rate-limit window for this caller.
The number of requests remaining in the current rate-limit window.
The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.
The request is malformed, or it carries an If-Match header, which this endpoint can’t evaluate. Send no If-Match, or *.
The frozen public-API error contract. error codes are stable snake_case strings. Wire keys
are frozen snake_case too (error, message, docs_url, fields,
retry_after) — the global camelCase naming policy would otherwise emit
docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName
always wins over the policy, so these are pinned explicitly rather than relying on the
property names already being lowercase for the single-word ones.
did_you_mean, next_actions and connection_id are ADDITIVE optional keys
(null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so
pre-existing error bodies are byte-for-byte unchanged when they’re absent.
connection_id is present only on the sso_required error: the organization
requires single sign-on, and this credential didn’t come through its identity provider.
connection_id identifies which SSO connection to sign in with.
plan_limit is present only on the plan_limit_reached error: which plan cap the
request would have exceeded, so a client can branch on it without parsing message.
change_freeze is present only on the change_frozen error (#4645): the change freeze that refused the
write, so a client can show when it ends and whether the caller may break it, without parsing message.
object
object
object
The cap behind a plan_limit_reached error. resource is the capped collection
(projects, environments, flags, webhooks, members);
plan is the plan’s wire name, as GET /api/v1/orgs/{org} returns it; max is
the cap. The environment and flag caps are per project.
object
The freeze behind a change_frozen error: id and name of the window, the environment’s
environment_key, ends_at (UTC; always present, null for an open-ended window) and whether the caller’s role may
break it (can_override, with X-Freeze-Override: true and an X-Intent-Reason).
object
Example
{ "error": "not_found", "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.", "docs_url": "https://featureflip.io/docs/management-api/errors/not_found", "did_you_mean": [ "new-checkout-flow" ], "next_actions": [ { "method": "GET", "path": "/api/v1/orgs/acme/projects/checkout/flags" } ]}Headers
Section titled “ Headers ”The maximum number of requests permitted per rate-limit window for this caller.
The number of requests remaining in the current rate-limit window.
The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.
Authentication is required, or the supplied API token is invalid or expired.
The frozen public-API error contract. error codes are stable snake_case strings. Wire keys
are frozen snake_case too (error, message, docs_url, fields,
retry_after) — the global camelCase naming policy would otherwise emit
docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName
always wins over the policy, so these are pinned explicitly rather than relying on the
property names already being lowercase for the single-word ones.
did_you_mean, next_actions and connection_id are ADDITIVE optional keys
(null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so
pre-existing error bodies are byte-for-byte unchanged when they’re absent.
connection_id is present only on the sso_required error: the organization
requires single sign-on, and this credential didn’t come through its identity provider.
connection_id identifies which SSO connection to sign in with.
plan_limit is present only on the plan_limit_reached error: which plan cap the
request would have exceeded, so a client can branch on it without parsing message.
change_freeze is present only on the change_frozen error (#4645): the change freeze that refused the
write, so a client can show when it ends and whether the caller may break it, without parsing message.
object
object
object
The cap behind a plan_limit_reached error. resource is the capped collection
(projects, environments, flags, webhooks, members);
plan is the plan’s wire name, as GET /api/v1/orgs/{org} returns it; max is
the cap. The environment and flag caps are per project.
object
The freeze behind a change_frozen error: id and name of the window, the environment’s
environment_key, ends_at (UTC; always present, null for an open-ended window) and whether the caller’s role may
break it (can_override, with X-Freeze-Override: true and an X-Intent-Reason).
object
Example
{ "error": "not_found", "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.", "docs_url": "https://featureflip.io/docs/management-api/errors/not_found", "did_you_mean": [ "new-checkout-flow" ], "next_actions": [ { "method": "GET", "path": "/api/v1/orgs/acme/projects/checkout/flags" } ]}Headers
Section titled “ Headers ”The maximum number of requests permitted per rate-limit window for this caller.
The number of requests remaining in the current rate-limit window.
The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.
Forbidden
The frozen public-API error contract. error codes are stable snake_case strings. Wire keys
are frozen snake_case too (error, message, docs_url, fields,
retry_after) — the global camelCase naming policy would otherwise emit
docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName
always wins over the policy, so these are pinned explicitly rather than relying on the
property names already being lowercase for the single-word ones.
did_you_mean, next_actions and connection_id are ADDITIVE optional keys
(null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so
pre-existing error bodies are byte-for-byte unchanged when they’re absent.
connection_id is present only on the sso_required error: the organization
requires single sign-on, and this credential didn’t come through its identity provider.
connection_id identifies which SSO connection to sign in with.
plan_limit is present only on the plan_limit_reached error: which plan cap the
request would have exceeded, so a client can branch on it without parsing message.
change_freeze is present only on the change_frozen error (#4645): the change freeze that refused the
write, so a client can show when it ends and whether the caller may break it, without parsing message.
object
object
object
The cap behind a plan_limit_reached error. resource is the capped collection
(projects, environments, flags, webhooks, members);
plan is the plan’s wire name, as GET /api/v1/orgs/{org} returns it; max is
the cap. The environment and flag caps are per project.
object
The freeze behind a change_frozen error: id and name of the window, the environment’s
environment_key, ends_at (UTC; always present, null for an open-ended window) and whether the caller’s role may
break it (can_override, with X-Freeze-Override: true and an X-Intent-Reason).
object
Example
{ "error": "not_found", "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.", "docs_url": "https://featureflip.io/docs/management-api/errors/not_found", "did_you_mean": [ "new-checkout-flow" ], "next_actions": [ { "method": "GET", "path": "/api/v1/orgs/acme/projects/checkout/flags" } ]}Headers
Section titled “ Headers ”The maximum number of requests permitted per rate-limit window for this caller.
The number of requests remaining in the current rate-limit window.
The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.
Not Found
The frozen public-API error contract. error codes are stable snake_case strings. Wire keys
are frozen snake_case too (error, message, docs_url, fields,
retry_after) — the global camelCase naming policy would otherwise emit
docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName
always wins over the policy, so these are pinned explicitly rather than relying on the
property names already being lowercase for the single-word ones.
did_you_mean, next_actions and connection_id are ADDITIVE optional keys
(null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so
pre-existing error bodies are byte-for-byte unchanged when they’re absent.
connection_id is present only on the sso_required error: the organization
requires single sign-on, and this credential didn’t come through its identity provider.
connection_id identifies which SSO connection to sign in with.
plan_limit is present only on the plan_limit_reached error: which plan cap the
request would have exceeded, so a client can branch on it without parsing message.
change_freeze is present only on the change_frozen error (#4645): the change freeze that refused the
write, so a client can show when it ends and whether the caller may break it, without parsing message.
object
object
object
The cap behind a plan_limit_reached error. resource is the capped collection
(projects, environments, flags, webhooks, members);
plan is the plan’s wire name, as GET /api/v1/orgs/{org} returns it; max is
the cap. The environment and flag caps are per project.
object
The freeze behind a change_frozen error: id and name of the window, the environment’s
environment_key, ends_at (UTC; always present, null for an open-ended window) and whether the caller’s role may
break it (can_override, with X-Freeze-Override: true and an X-Intent-Reason).
object
Example
{ "error": "not_found", "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.", "docs_url": "https://featureflip.io/docs/management-api/errors/not_found", "did_you_mean": [ "new-checkout-flow" ], "next_actions": [ { "method": "GET", "path": "/api/v1/orgs/acme/projects/checkout/flags" } ]}Headers
Section titled “ Headers ”The maximum number of requests permitted per rate-limit window for this caller.
The number of requests remaining in the current rate-limit window.
The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.
Conflict
The frozen public-API error contract. error codes are stable snake_case strings. Wire keys
are frozen snake_case too (error, message, docs_url, fields,
retry_after) — the global camelCase naming policy would otherwise emit
docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName
always wins over the policy, so these are pinned explicitly rather than relying on the
property names already being lowercase for the single-word ones.
did_you_mean, next_actions and connection_id are ADDITIVE optional keys
(null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so
pre-existing error bodies are byte-for-byte unchanged when they’re absent.
connection_id is present only on the sso_required error: the organization
requires single sign-on, and this credential didn’t come through its identity provider.
connection_id identifies which SSO connection to sign in with.
plan_limit is present only on the plan_limit_reached error: which plan cap the
request would have exceeded, so a client can branch on it without parsing message.
change_freeze is present only on the change_frozen error (#4645): the change freeze that refused the
write, so a client can show when it ends and whether the caller may break it, without parsing message.
object
object
object
The cap behind a plan_limit_reached error. resource is the capped collection
(projects, environments, flags, webhooks, members);
plan is the plan’s wire name, as GET /api/v1/orgs/{org} returns it; max is
the cap. The environment and flag caps are per project.
object
The freeze behind a change_frozen error: id and name of the window, the environment’s
environment_key, ends_at (UTC; always present, null for an open-ended window) and whether the caller’s role may
break it (can_override, with X-Freeze-Override: true and an X-Intent-Reason).
object
Example
{ "error": "not_found", "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.", "docs_url": "https://featureflip.io/docs/management-api/errors/not_found", "did_you_mean": [ "new-checkout-flow" ], "next_actions": [ { "method": "GET", "path": "/api/v1/orgs/acme/projects/checkout/flags" } ]}Headers
Section titled “ Headers ”The maximum number of requests permitted per rate-limit window for this caller.
The number of requests remaining in the current rate-limit window.
The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.
Rate limit exceeded. Retry after the interval indicated by the Retry-After header.
The frozen public-API error contract. error codes are stable snake_case strings. Wire keys
are frozen snake_case too (error, message, docs_url, fields,
retry_after) — the global camelCase naming policy would otherwise emit
docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName
always wins over the policy, so these are pinned explicitly rather than relying on the
property names already being lowercase for the single-word ones.
did_you_mean, next_actions and connection_id are ADDITIVE optional keys
(null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so
pre-existing error bodies are byte-for-byte unchanged when they’re absent.
connection_id is present only on the sso_required error: the organization
requires single sign-on, and this credential didn’t come through its identity provider.
connection_id identifies which SSO connection to sign in with.
plan_limit is present only on the plan_limit_reached error: which plan cap the
request would have exceeded, so a client can branch on it without parsing message.
change_freeze is present only on the change_frozen error (#4645): the change freeze that refused the
write, so a client can show when it ends and whether the caller may break it, without parsing message.
object
object
object
The cap behind a plan_limit_reached error. resource is the capped collection
(projects, environments, flags, webhooks, members);
plan is the plan’s wire name, as GET /api/v1/orgs/{org} returns it; max is
the cap. The environment and flag caps are per project.
object
The freeze behind a change_frozen error: id and name of the window, the environment’s
environment_key, ends_at (UTC; always present, null for an open-ended window) and whether the caller’s role may
break it (can_override, with X-Freeze-Override: true and an X-Intent-Reason).
object
Example
{ "error": "not_found", "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.", "docs_url": "https://featureflip.io/docs/management-api/errors/not_found", "did_you_mean": [ "new-checkout-flow" ], "next_actions": [ { "method": "GET", "path": "/api/v1/orgs/acme/projects/checkout/flags" } ]}Headers
Section titled “ Headers ”Number of seconds to wait before retrying the request.
The maximum number of requests permitted per rate-limit window for this caller.
The number of requests remaining in the current rate-limit window.
The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.