Docs Sign in Start building

Write an approval policy

approval_policy.write

Publishes the next version of the tenant's approval policy under key. Every role a row names must be held by a member of the tenant, and no two rows may cover one amount: bands in one currency must not overlap, and a row with no band must stand alone. A program's `requires approval "<key>"` resolves the newest version when a call is admitted and pins its digest; calls already pending keep the version they pinned. The five Core gates are policies under `core.gate.<gate>`: writing one makes that gate required. A member with desk.settings.manage writes it from the console, or from their own CLI login (hyperscale auth login) in the sandbox only. An OAuth client with blueprints:write writes only core.gate.<gate> keys and is refused any other with oauth_client_not_admitted. A role no member holds refuses with approval_policy_invalid. Staff may write it for a tenant from the admin portal. Callers: the account owner's own CLI login (`hyperscale auth login`). An agent token is refused.

POST /v1/approval-policies/{key}

Principal user_session. Idempotency required. Environment either.

Input

FieldInTypeDescription
key requiredpathstringThe key a program names, such as funding.release
X-Hyperscale-Environmentheadersandbox | live
Idempotency-Key requiredheaderstring
X-Hyperscale-Rehearsalheader"true"`true` runs the request through admission and execution, keeps nothing, and answers OperationRehearsal with 200 in place of the operation's own output. Needs a signed-in caller. Identity operations, such as sign-in, sessions, team members and agent grants, refuse it with invalid_request.
rows requiredbodyobject[]The bands; admission takes the one that holds the amount

Output

FieldTypeDescription
tenantId requiredstringOrganization tenant ID
key requiredstringThe key a program names, such as funding.release
version requiredinteger
digest requiredstring

Request sample

Only a signed-in person may call this: the founder's own CLI after hyperscale auth login. A Product key cannot, so the SDK, which signs in with a Product key or a customer session, has no sample for it.

curl

curl --request POST 'https://hyperscale0.ai/v1/approval-policies/funding.release' \
  --header "Authorization: Bearer $HYPERSCALE_TOKEN" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header "Idempotency-Key: $(uuidgen)" \
  --header 'Content-Type: application/json' \
  --data-raw '{"rows":[{"by":["credit_officer"],"count":1,"band":{"currency":"SAR","below":"100000000"}},{"by":["credit_officer","credit_committee"],"count":2,"band":{"currency":"SAR","from":"100000000"}}]}'

CLI

hyperscale api call approval_policy.write \
  --input '{"key":"funding.release","rows":[{"by":["credit_officer"],"count":1,"band":{"currency":"SAR","below":"100000000"}},{"by":["credit_officer","credit_committee"],"count":2,"band":{"currency":"SAR","from":"100000000"}}]}'

Errors

CodeHTTPCause
csrf_token_invalid403A browser session mutation did not carry a current Hyperscale CSRF token.
environment_mismatch403The session was issued for sandbox or live and the request targets the other environment.
idempotency_conflict409The request reused an Idempotency-Key for a different logical mutation.
idempotency_required400The operation is a mutation and Hyperscale requires a replay key before executing it.
internal_error500Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience.
invalid_request400The request does not match the API reference.
method_not_allowed405The route exists, but not for the request's HTTP method.
missing_required_permission403The signed-in member's current role does not grant the permission required for this operation.
missing_required_scope403The credential is valid but does not grant one or more operation scopes.
not_found404No Hyperscale route matched the requested path and method.
oauth_client_not_admitted403The bearer is an OAuth client token, and this operation does not admit the oauth2_client principal.
product_access_suspended403The Product is disabled or closed, so its credentials are suspended in every environment.
product_activation_required403The live Product or required live capability is not active yet.
rate_limited429The credential sent more than its limit in the current 60-second window: 600 requests per API key or session, 1,200 per IP address. Every response carries `x-ratelimit-limit`, `x-ratelimit-remaining` and `x-ratelimit-reset` (Unix seconds).
request_body_too_large413The JSON request body exceeded Hyperscale's accepted payload size.
resource_not_found404The requested resource does not exist in the credential's visible scope.
state_conflict409The operation conflicts with the current durable state of the resource.
state_constraint_failed422The request is syntactically valid but violates a business-state constraint.
tenant_mismatch403The request mixed tenant-owned identifiers across tenant boundaries.
tenant_not_found404The credential resolved to a tenant Hyperscale cannot find.
unauthorized403The request did not include a valid Hyperscale bearer credential for this environment.
agent_token_expired401The agent token is real, but its grant ended. A grant lasts 30 days, or 7 days unused. `details.expiresAt` holds the date in ISO 8601 and `details.agentName` names the agent.
agent_token_replaced401The account owner ran `hyperscale agent setup` again for this agent, which replaced this token with a newer one. `details.agentName` names the agent and `details.replacedAt` holds the date.
approval_policy_invalid422Two rows cover one amount, a row with no band sits beside others, or a row names a staff role no member of the company holds. No version was written.
device_login_expired401The bearer is the account owner's own device login from `hyperscale auth login`, not an agent token. Its access token lasts an hour and the CLI refreshes it; the login itself ends after 30 days, or 7 days unused. `details.expiresAt` holds when it ended in ISO 8601.
instrument_instance_not_found404No record of this instrument matches the `instanceId` in this Product, company and environment. `details.instrumentId` and `details.instrumentInstanceId` name what was looked up.
invalid_credentials401Hyperscale could not accept the account or credential request. Signup, login, and bearer authentication use one 401 for every case they reject, so the response exposes no credential-specific reason or registered-email verdict. The single exception is a key that is real but homed in the other environment: because the presented secret already matched a stored key, the message names the mismatch instead of leaving a working credential looking unknown. A bearer that matched nothing gets text that fits its prefix (an agent token, a refresh token, a personal access token, a session or no Hyperscale token at all), which says only what the caller sent, never whether a credential like it exists.
operation_not_finalized409The operation in `details.operationId` has started but has no final receipt. It is still running, or its outcome is unknown after a failure past the point where it may have committed. `details.error` carries the underlying failure when there is one.
session_expired401The session behind this request has ended. A console session ends 30 days after sign-in, or after 12 hours with no request. An admin or customer session ends 24 hours after sign-in, or after 15 minutes with no request. A personal access token ends at the `expiresAt` set when it was created.
session_required401This operation needs a person signed in through the browser or the `hyperscale` CLI. A Product API key cannot call it. The request carried no session, or its token matched no live session.
session_revoked401The session or personal access token behind this request was ended before its expiry. Sign-out, `user.session.revoke`, a password reset, a role change, removal from the team, user suspension and `personal_access_token.revoke` all end sessions.
tenant_status_forbidden409The company is suspended or closed, so every credential bound to it is refused, reads included. `details.tenantId` names the company.

All operations