Skip to main content

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.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body fields:

  • api_key (string, required): Numeral secret key (sk_test_… or sk_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​

OK

Response Headers
    Content-Type