Replace Numeral API Key
PUT/api/numeral/instances/:instance/key
Replaces the stored secret key after validating it live. Clears a previous key error. Switching between a test and a production key re-sends every record to the new account on its next push.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields:
- api_key (string, required): Numeral secret key (
sk_test_…orsk_prod_…).
Numeral failures return 422 with a stable code: invalid_key (Numeral did not recognise this key), production_key_refused (a production key on a non-production SKU.io), rate_limited, api_error (Numeral refused the request; message carries its reason) or unreachable (Numeral could not be reached).
Authentication: Requires a Bearer token. Requires the integrations.update permission.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.