Update business object

Updates an existing business object. While active, you can change only the name and description. To add or remove fields, deactivate the business object first.

Header Parameters
PubNub-Version string — REQUIRED

Possible values: [2026-02-09]

Request Body — REQUIRED
name string — REQUIRED

Possible values: 1 ≤ length ≤ 50

Business object name (1-50 characters).

isActive boolean

Whether to start capturing data (default: false).

description string

Possible values: length ≤ 200

Description (max 200 characters).

fields object[]

Data fields for the business object (max 100).

id string

PubNub-generated unique ID for the field. Required when creating metrics and decisions. Used as measureId, dimensionIds, or inputFields[].sourceId.

name string — REQUIRED

Possible values: 1 ≤ length ≤ 50

Field name (1-50 characters).

source string

Possible values: [JSONPATH, DERIVED]

Field source type: JSONPATH or DERIVED.

jsonPath string

Possible values: length ≤ 200

JSON path expression for extracting data (max 200 chars). Required when source is JSONPATH and isActive is true.

jsonFieldType string

Possible values: [TEXT, TEXT_LONG, NUMERIC, TIMESTAMP, DURATION_SECONDS]

Field data type: TEXT, TEXT_LONG (character limit is 1000, limited to 5 per Business Object), NUMERIC, or TIMESTAMP. Required when source is JSONPATH.

isKeyset boolean

Boolean flag indicating if this field is part of the keyset. Informational only.

derivation object

Derivation configuration. Required when source is DERIVED.

operation string — REQUIRED

Possible values: [TIME_DIFF]

Derivation operation type. Currently only TIME_DIFF is supported.

params object — REQUIRED

Parameters for the derivation calculation.

startSource string — REQUIRED

Possible values: [DATA_FIELD, PUBLISH_TIMETOKEN]

Start source for time difference calculation: DATA_FIELD or PUBLISH_TIMETOKEN. DATA_FIELD accepts only TIMESTAMP data type.

startFieldIndex number

Index or position of the start timestamp data field in your array. Not required if startSource is PUBLISH_TIMETOKEN.

endSource string — REQUIRED

Possible values: [DATA_FIELD, PUBLISH_TIMETOKEN]

End source for time difference calculation: DATA_FIELD or PUBLISH_TIMETOKEN.

endFieldIndex number

Index or position of the end timestamp data field in your array. Not required if endSource is PUBLISH_TIMETOKEN.

subkeys string[] — REQUIRED

PubNub subscribe keys to capture data from (min 0, max 10). At least one subscribe key must be specified to activate the Business Object.

Responses
200
Schema — OPTIONAL
createdAt date-time — OPTIONAL

Creation timestamp (ISO 8601, UTC).

updatedAt date-time — OPTIONAL

Last update timestamp (ISO 8601, UTC).

createdBy string — OPTIONAL

Email of the creator.

updatedBy string — OPTIONAL

Email of the last updater.

id string

PubNub-generated unique ID for the Business Object. Required in later requests for GET, UPDATE, and DELETE methods.

name string

Business object name (1-50 characters).

isActive boolean

Whether to start capturing data (default: false).

description string — OPTIONAL

Description (max 200 characters).

fields object[] — OPTIONAL

Data fields for the business object (max 100).

id string

PubNub-generated unique ID for the field. Required when creating metrics and decisions. Used as measureId, dimensionIds, or inputFields[].sourceId.

name string

Field name (1-50 characters).

jsonPath string — OPTIONAL

JSON path expression for extracting data (max 200 chars). Required when source is JSONPATH and isActive is true.

jsonFieldType string

Possible values: [TEXT, TEXT_LONG, NUMERIC, TIMESTAMP, DURATION_SECONDS]

Field data type: TEXT, TEXT_LONG (character limit is 1000, limited to 5 per Business Object), NUMERIC, or TIMESTAMP. Required when source is JSONPATH.

isKeyset boolean

Boolean flag indicating if this field is part of the keyset. Informational only.

source string

Possible values: [JSONPATH, DERIVED]

Field source type: JSONPATH or DERIVED.

derivation object — OPTIONAL

Derivation configuration. Required when source is DERIVED.

operation string

Possible values: [TIME_DIFF]

Derivation operation type. Currently only TIME_DIFF is supported.

params object

Parameters for the derivation calculation.

startSource string

Possible values: [DATA_FIELD, PUBLISH_TIMETOKEN]

Start source for time difference calculation: DATA_FIELD or PUBLISH_TIMETOKEN. DATA_FIELD accepts only TIMESTAMP data type.

startFieldIndex number — OPTIONAL

Index or position of the start timestamp data field in your array. Not required if startSource is PUBLISH_TIMETOKEN.

endSource string

Possible values: [DATA_FIELD, PUBLISH_TIMETOKEN]

End source for time difference calculation: DATA_FIELD or PUBLISH_TIMETOKEN.

endFieldIndex number — OPTIONAL

Index or position of the end timestamp data field in your array. Not required if endSource is PUBLISH_TIMETOKEN.

accountId string

Your PubNub account ID.

subkeys string[]

PubNub subscribe keys to capture data from (min 0, max 10). At least one subscribe key must be specified to activate the Business Object.

metrics (circular)[] — OPTIONAL

Associated metrics for this business object.

decisions (circular)[] — OPTIONAL

Associated decisions for this business object.

dashboards object[] — OPTIONAL

Associated dashboards for this business object.

createdAt date-time — OPTIONAL

Creation timestamp (ISO 8601, UTC).

updatedAt date-time — OPTIONAL

Last update timestamp (ISO 8601, UTC).

createdBy string — OPTIONAL

Email of the creator.

updatedBy string — OPTIONAL

Email of the last updater.

id string

PubNub-generated unique ID for the dashboard. Required in later requests to update, delete, or retrieve the dashboard.

name string

Dashboard title (max 50 characters).

accountId string

Your PubNub account ID.

dateRange string

Possible values: [30 minutes, 1 hour, 24 hours, 3 days, 1 week, 30 days, 3 months, Custom date]

Date range for dashboard data: 30 minutes, 1 hour, 24 hours, 3 days, 1 week, 30 days, 3 months, or Custom date.

startDate date-time — OPTIONAL

Custom start date/time (ISO 8601). Required when dateRange is Custom date.

endDate date-time — OPTIONAL

Custom end date/time (ISO 8601). Required when dateRange is Custom date.

charts object[]

List of charts to display on the dashboard.

id string
series object[]
title string
metric string
values object[]
date date-time
value number
tooltip string
customer object — OPTIONAL

Associated OEM customer for this dashboard.

id string

Your unique customer ID for OEM partners (requires Partner Portal).

name string

Customer name.

queries (circular)[] — OPTIONAL

Associated queries for this business object.

customers object[] — OPTIONAL

Associated OEM customers for this business object.

id string

Your unique customer ID for OEM partners (requires Partner Portal).

name string

Customer name.

404
* required
PubNub-Version*
Type: string
Possible values: [2026-02-09]
* required
name*
Type: string
Business object name (1-50 characters).
1-50 chars
isActive
Type: boolean
Whether to start capturing data (default: false).
Default: false
description
Type: string
Description (max 200 characters).
≤ 200 chars
fields
Type: array
Data fields for the business object (max 100).
Array items:
items
Type: object
subkeys*
Type: array
PubNub subscribe keys to capture data from (min 0, max 10). At least one subscribe key must be specified to activate the Business Object.
≥ 1 items
Array items:
items
Type: string
createdAt
Type: string
Creation timestamp (ISO 8601, UTC).
Format: date-time
updatedAt
Type: string
Last update timestamp (ISO 8601, UTC).
Format: date-time
createdBy
Type: string
nullableEmail of the creator.
updatedBy
Type: string
nullableEmail of the last updater.
id
Type: string
PubNub-generated unique ID for the Business Object. Required in later requests for GET, UPDATE, and DELETE methods.
name
Type: string
Business object name (1-50 characters).
isActive
Type: boolean
Whether to start capturing data (default: false).
description
Type: string
Description (max 200 characters).
fields
Type: array
Data fields for the business object (max 100).
Array items:
items
Type: object
accountId
Type: string
Your PubNub account ID.
subkeys
Type: array
PubNub subscribe keys to capture data from (min 0, max 10). At least one subscribe key must be specified to activate the Business Object.
Array items:
items
Type: string
metrics
Type: array
Associated metrics for this business object.
Array items:
items
Type: any
decisions
Type: array
Associated decisions for this business object.
Array items:
items
Type: any
dashboards
Type: array
Associated dashboards for this business object.
Array items:
items
Type: object
queries
Type: array
Associated queries for this business object.
Array items:
items
Type: any
customers
Type: array
Associated OEM customers for this business object.
Array items:
items
Type: object