Skip to content
FSCO Docs

Create metadata

POST
/v2/metadata

Create new metadata records for aggregates.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-API-Key
string

API Key

X-API-Secret
string

API Secret

Request Body required

Section titled “Request Body required ”
object
aggregates
required

Array of metadata aggregates to create

Array<object>
object
aggregateId
required

The aggregate ID for this metadata group

string
88f39775-01f6-43ef-b553-08410c588116
metadata
required

Array of metadata items for this aggregate

Array<object>
object
typeId
required

The type ID for this metadata item

string
88f39775-01f6-43ef-b553-08410c588116
value
required

The value of the metadata item (can be string, number, boolean, or array)

Array<string>
Sample metadata value

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Comma-separated list of created metadata IDs.

object
aggregates
required

Array of aggregates with their metadata

Array<object>
object 
[
  {
    "aggregateId": "88f39775-01f6-43ef-b553-08410c588116",
    "metadata": [
      {
        "id": "987fcdeb-51a2-43d1-9f12-345678901234",
        "value": "Some value",
        "key": "user_preferences",
        "description": "Stores user preferences",
        "displayName": "User Preferences"
      }
    ]
  }
]