updateOrganisation

Mock

Mock. This operation is part of the approved contract but its module is not built yet. Run Core with N1_API_MODE=mock N1_DEV_AUTH=stub to get deterministic demo-shop data from it. The real server answers NOT_IMPLEMENTED until it ships; the schema and examples here will not change when it does.

Change the shop profile or settings

Compare

Change the shop profile or settings. Owner and admin only.

POST/graphqlapp audience

Who can call this. Owner and admin. You can run it against Local or Staging from the request panel, with a demo-shop token.

Headers

Required Optional

AuthorizationstringRequired
Bearer <token>, issued for this endpoint's audience. The token decides the shop and roles; nothing in the request body can change them.
Example: Bearer eyJhbGciOiJFZERTQSJ9…
Content-TypestringRequired
Always application/json. Only POST is accepted.
Example: application/json
Idempotency-KeystringRequired
A key you generate once per user action (a UUID). Retrying with the same key never applies the change twice.
Example: 0192f0c1-9b2a-7d40-8c3e-1f5a6b7c8d9e
X-Request-IdstringOptional
Your id for this request (8–128 characters of A–Z a–z 0–9 . _ : -). Echoed back in the response header and in every error, so you can quote it when reporting a problem. Core makes one if you send none.
Example: app-7f3c2a9e-checkout

Arguments

Required Optional

inputUpdateOrganisationInput!Required
The changes.
Example: {"invoicePrefix":"DEMO"}
Show children
- addressAddressInputOptional
  Registered address.
- fyStartMonthIntOptional
  Month the financial year starts, 1–12.
- gstinStringOptional
  GSTIN.
- invoicePrefixStringOptional
  Prefix of invoice numbers.
- nameStringOptional
  Trade name.
- stateCodeStringOptional
  GST state code.
- timezoneStringOptional
  IANA timezone.

Returns

Required Optional

updateOrganisationOrganisation!Required
Change the shop profile or settings. Owner and admin only.
Show children
- addressAddress!Required
  Registered address.
  Show children
  - cityString!Required
    City or town.
  - line1String!Required
    Building, street.
  - line2StringOptional
    Area, landmark.
  - pincodeString!Required
    6-digit PIN code.
  - stateString!Required
    State name.
- fyStartMonthInt!Required
  Month the financial year starts, 1–12 (4 = April).
  Example: 4
- gstinStringOptional
  GSTIN, if registered.
- idID!Required
  The shop id (the tenant).
  Example: "0192f0c1-0000-7000-8000-00000000000a"
- invoicePrefixString!Required
  Prefix of invoice numbers.
  Example: "DEMO"
- nameString!Required
  Trade name.
  Example: "Demo Precision Works"
- stateCodeString!Required
  GST state code (2 digits); decides CGST+SGST or IGST.
- timezoneString!Required
  IANA timezone people read times in.

Errors

Code	HTTP	When
`FORBIDDEN`	`403`	Signed in, but the role or tenant does not allow the action.
`VALIDATION_FAILED`	`400`	Input failed Zod or route schema validation. `details` lists each field path and problem.

Every error has the same body. See Errors.

Rate limit tier

Tier: per user. Over the limit you get RATE_LIMITED (HTTP 429) with a Retry-After header. See Response handling.