POST smartwords

Create or update smartwords

POST /smartwords

This endpoint updates key–value data stored in the smartwords (custom_data) of the simulation space.

If the index exists then value data is overwritten, else a new entry created.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

The request body must be an array of Smartword index-value pairs - see example.

Name
Type
Description

index

string

Unique key for the custom data entry.

value

string

Text value associated with the index.

Example

[
  {
    "index": "weather_condition",
    "value": "Heavy rain"
  },
  {
    "index": "fuel_supply",
    "value": "Low"
  },
  {
    "index": "public_alert_level",
    "value": "Amber"
  }
]

Response

Success. Array has been updated.

Not response body provided

Last updated

Was this helpful?