Hyperscale docs Sign in Start building

Create an object with optional metadata and no financial agreement

product.objects.create

Creates a new business object instance with an optional externalId and optional metadata fields. The owner is the caller, or the customer named in onBehalfOf.

POST /v1/products/{productId}/objects/{kind}

Scopes: product:write

Input

FieldTypeDescription
productId requiredstringHyperscale product ID
kind requiredstring
externalIdstring
fieldsobject
onBehalfOfstringCustomer the Product key or a member session acts for. The call runs with that customer's accounts and keeps the operator's view of records.
idempotencyKey requiredstringNew per change; reuse only to retry it.

Request sample

curl --request POST 'https://console.hyperscale0.ai/v1/products/{productId}/objects/{kind}' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "idempotencyKey": "<string>"
}'

All operations