Skip to main content

Projects & Environments

PATCH/v1/orgs/{org_id}

Update Organization

Update organization details (name, industry, company_size).

CI or Admin tokenscope: writeoperation_id: orgs.update

Authentication

Requires a CI- or admin-level token. Runtime tokens are rejected for mutations.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional
authorization#headerstring | nulloptional

Request bodyrequired

FieldTypeRequiredDescription
namestring | nulloptional
industrystring | nulloptional
company_sizestring | nulloptional

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

idrequiredstring
namerequiredstring
slugrequiredstring
planrequiredstring
industrystring
company_sizestring
created_atrequiredstring

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.
403Token does not have the required role (admin / editor).
404Target resource does not exist in this org.
422Request body failed validation.

Request

curl -X PATCH 'https://api.znyx.ai/v1/orgs/00000000-0000-0000-0000-000000000000' \
  -H 'Authorization: Bearer $ZNYX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": null,
  "industry": null,
  "company_size": null
}'

Response

application/json

Successful Response

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "plan": "string",
  "industry": "string",
  "company_size": "string",
  "created_at": "string"
}

Schema: object