Skip to main content

WorkspacePatch

Represents an update to a Workspace. Fields that are set will be updated.

input WorkspacePatch {
  id: String
  slug: String
  name: String
  domains: [String]
  website: String
  glyphUrl: String
  logoUrl: String
  billingAccountId: String
  version: Int
  deletedAt: Datetime
  updatedAt: Datetime
  createdAt: Datetime
  type: String
  productId: String
  paidSeatCount: Int
  workosOrganizationId: String
  partnerDomains: [String]
}

Fields​

WorkspacePatch.id ● String scalar​

WorkspacePatch.slug ● String scalar​

URL-safe unique identifier for the workspace, used in links; distinct from the display name.

WorkspacePatch.name ● String scalar​

WorkspacePatch.domains ● [String] list scalar​

The workspace's own seller-side email domains. A member with one of these cannot be added customer-side, and they gate the approved-domain accord sign-in described on accord.allowed_access. Unauthenticated sessions read a single empty string rather than the real list.

WorkspacePatch.website ● String scalar​

WorkspacePatch.glyphUrl ● String scalar​

WorkspacePatch.logoUrl ● String scalar​

WorkspacePatch.billingAccountId ● String scalar​

Identifier of the external billing account for this workspace.

WorkspacePatch.version ● Int scalar​

WorkspacePatch.deletedAt ● Datetime scalar​

WorkspacePatch.updatedAt ● Datetime scalar​

WorkspacePatch.createdAt ● Datetime scalar​

WorkspacePatch.type ● String scalar​

Free-text classification of the workspace. Writable through the generated CRUD, but no application code currently sets or reads it.

WorkspacePatch.productId ● String scalar​

Identifier of the subscribed product/plan. Unauthenticated sessions read null.

Number of paid seats provisioned for the workspace.

WorkspacePatch.workosOrganizationId ● String scalar​

Linked WorkOS organization id, used for SSO and directory sync.

WorkspacePatch.partnerDomains ● [String] list scalar​

Email domains whose members are treated as partners: they join on the customer side with workspace_account.is_partner set, and are the only members partner-scoped resources resolve for. Unauthenticated sessions read a single empty string rather than the real list.

Member Of​

UpdateWorkspaceByNodeIdInput input ● UpdateWorkspaceInput input