CustomRecord

A tenant-scoped custom JSON record identified by collection + key. Records are persisted in the Tools store and can optionally be scoped to a brand through metadata.

type CustomRecord {
  archivedAt: ISO8601DateTime
  brandId: ID
  collection: String!
  companyId: ID!
  data: JSON!
  id: ID!
  key: String!
  notificationDeliveredAt: ISO8601DateTime
  notificationDeliveryStatus: String
  schemaVersion: Int!
  updatedAt: ISO8601DateTime!
}

Fields

CustomRecord.archivedAt ● ISO8601DateTime scalar common

When the record was archived, if soft-deleted.

CustomRecord.brandId ● ID scalar common

Optional brand scope for this record.

CustomRecord.collection ● String! non-null scalar common

The collection this record belongs to.

CustomRecord.companyId ● ID! non-null scalar common

The company that owns this record.

CustomRecord.data ● JSON! non-null scalar common

The persisted JSON payload.

CustomRecord.id ● ID! non-null scalar common

Stable record identifier (UUID).

CustomRecord.key ● String! non-null scalar common

Stable key within the collection.

CustomRecord.notificationDeliveredAt ● ISO8601DateTime scalar common

When notification was confirmed delivered, if any.

CustomRecord.notificationDeliveryStatus ● String scalar common

Outcome of the collection notification: skipped, delivered, or failed.

CustomRecord.schemaVersion ● Int! non-null scalar common

Version of the data schema managed by the caller.

CustomRecord.updatedAt ● ISO8601DateTime! non-null scalar common

When the record was last persisted.

Returned By

archiveCustomRecord mutation ● customRecord query ● customRecords query ● upsertCustomRecord mutation