Update workspace settings

PUT/v1/settings

Body parameters

application/json · required

field string required

field for this setting.

Allowed values: "name", "slug", "officialName", "tradeName", "registrationNumber", "taxId", "email", "phone", "address", "city", "state", "zip", "country"

Examplename

value string required

Value returned by the operation.

Maximum length: 2048 characters.

Example100.00

Headers

authorization string required

Bearer workspace API key.

ExampleBearer $NQD_API_KEY

workspace-id string required

Workspace scope for the request. Required for workspace operations and must belong to the authenticated identity.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Send the complete writable representation or change set. Use the latest updatedAt for If-Match.

Response

200Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

data object

Returned records. Collections and batches use an array; single records use an object.

ShowHide 28 properties

data.id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

data.name string

Display name of the record.

ExampleAcme workspace

data.slug string

slug for this setting.

Exampleacme-workspace

data.officialName string

official name for this setting.

ExampleConsulting services

data.tradeName string

trade name for this setting.

ExampleConsulting services

data.registrationNumber string

registration number for this setting.

ExampleCR-0001234567

data.taxId string

ID of the related tax.

Example100.00

data.defaultCurrencyId string

ID of the related default currency.

Examplenull

data.defaultInvoiceBankAccountId string

ID of the related default invoice bank account.

Examplenull

data.defaultIncomeBankAccountId string

ID of the related default income bank account.

Examplenull

data.defaultAssetBankAccountId string

ID of the related default asset bank account.

Examplenull

data.defaultExpenseBankAccountId string

ID of the related default expense bank account.

Examplenull

data.defaultPayoutBankAccountId string

ID of the related default payout bank account.

Examplenull

data.defaultExpenseRecurringBankAccountId string

ID of the related default expense recurring bank account.

Examplenull

data.email string

Email address associated with the identity.

Exampleowner@example.com

data.phone string

phone for this setting.

Example+966500000000

data.address string

address for this setting.

ExampleKing Fahd Road

data.city string

city for this setting.

ExampleRiyadh

data.state string

Current state of the record or operation.

ExampleRiyadh

data.postalCode string

postal code for this setting.

ExampleConsulting services

data.country string

country for this setting.

ExampleSA

data.createdBy string

Identifier of the identity that created the record.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1B

data.updatedBy string

Identifier of the identity that last updated the record.

Examplenull

data.deletedBy string

deleted by for this setting.

Examplenull

data.fiscalYearStartAt string

ISO 8601 timestamp for fiscal year start.

Example2026-01-15T12:00:00.000Z

data.createdAt string

ISO 8601 timestamp for the authored or payment event. Recurring records preserve their scheduled occurrence.

Example2026-01-15T12:00:00.000Z

data.updatedAt string

Timestamp used for stale-edit protection. Preserve the server value when updating.

Example2026-01-15T12:00:00.000Z

data.deletedAt string

ISO 8601 timestamp when the record was deleted, or null when it exists.

Examplenull

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

error object

Error details returned for a failed request.

ShowHide 4 properties

error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input

error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.

error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property

error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties

error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items

error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "invalid_query", "unsupported_media_type", "body_too_large", "body_timeout", "conflicting_scope", "missing_header", "concurrency_required", "invalid_resource_id", "invalid_request"

Exampleinvalid_request

error.details.issues[].code string nullable

Stable machine-readable error or resource code.

Exampleinvalid_input

{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}

View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗