API documentation | API docs for agents | OpenAPI 3.1

settings

ark.update_organization_settings

Updates tenant-admin organization profile fields, billing profile fields, and operational toggles with a partial patch. Payment fields require billing:write in addition to admin:write.

Availability: Expanded preview
Scopes: admin:write
ARK permissions: None
Team visibility: Not entity-scoped
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

namestring

min length: 1; max length: 200

mcNumberstring | null

max length: 50

dotNumberstring | null

max length: 50

addressobject | null

billingAddressobject | null

invoiceContactstring | null

max length: 500

invoiceInstructionsstring | null

max length: 5000

rateconTermsstring | null

max length: 5000

paymentobject

settingsobject

Example request

Shell

curl -X PATCH 'https://arktms.com/api/v1/organization/settings' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

Updated organization settings

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.messagestringrequired

data.changedarray<string>required

data.loadLocksClearedbooleanrequired

data.organizationobjectrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry