Interface OrgRequest._FinalStage
- All Known Implementing Classes:
OrgRequest.Builder
- Enclosing class:
OrgRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) build()Human-readable name for the organization.Free-form key-value attributes to store with the organization — use it to attach additional data from your own system.Optional ID of a record schema (created viaPOST /v1/schemas) that governs payload validation and lookup indexing for this organization, and must belong to your account.status(OrgRequestStatus status) status(Optional<OrgRequestStatus> status) Lifecycle status of the organization.
-
Method Details
-
build
OrgRequest build() -
additionalProperty
-
additionalProperties
-
name
Human-readable name for the organization.
-
name
-
status
Lifecycle status of the organization.
ACTIVEorganizations can be used normally;SUSPENDEDorganizations are retained but blocked from new operations. -
status
-
payload
Free-form key-value attributes to store with the organization — use it to attach additional data from your own system. On update, the supplied object replaces the stored payload in full (it is not key-merged); omit it to leave the stored payload unchanged.
-
payload
-
schemaId
Optional ID of a record schema (created via
POST /v1/schemas) that governs payload validation and lookup indexing for this organization, and must belong to your account. When set, the payload is validated against the schema on save and the schema's declared lookup fields become queryable viaGET /v1/orgs?type=...&field=...&value=...; when omitted, the payload is free-form and no lookup fields are indexed. Once set, this reference cannot currently be cleared. -
schemaId
-