Skip to main content

CmsBlock

A block of content on a page.

type CmsBlock {
  createdAt: DateTime!
  id: ID!
  isActive: Boolean!
  kind: HomeSectionKind!
  metadata: JSON
  order: Int!
  organizationId: ID!
  payload: JSON!
  surfaces: [PortalSurface!]!
  updatedAt: DateTime!
}

Fields​

CmsBlock.createdAt ● DateTime! non-null scalar​

When the record was created.

CmsBlock.id ● ID! non-null scalar​

The unique ID of this record.

CmsBlock.isActive ● Boolean! non-null scalar​

Whether the record is active.

CmsBlock.kind ● HomeSectionKind! non-null enum​

The kind of block.

CmsBlock.metadata ● JSON scalar​

Server-written provenance, e.g. { source: 'ai', model, generationId } for a row the section suggester drafted. Not settable by a client.

CmsBlock.order ● Int! non-null scalar​

The position of the block on the page.

CmsBlock.organizationId ● ID! non-null scalar​

The ID of the organization the record belongs to.

CmsBlock.payload ● JSON! non-null scalar​

Per-kind payload, as the retired Home CMS editor stored it.

CmsBlock.surfaces ● [PortalSurface!]! non-null enum​

Storefront surface(s) this section renders on (APP and/or PORTAL).

CmsBlock.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

Returned By​

cmsBlocks query