Account

Field	Required	Example Value
id	true	"internal-unique-identifier"
email	false	"[email protected]"
metadata	false	{"some-field": "some-value"}

A Note on Metadata

Account metadata accepts any valid json object. Additionally, if the metadata object passed changes over time the metadata field will extend the object stored. If the same key or nested key is passed it will only store the latest value.

For example:

Session 1

{
  "account": {
    "id": "test-account",
    "metadata": {
      "key-a": "field-a",
      "key-b": "field-b"
    }
  }
}

Session 2

{
  "account": {
    "id": "test-account",
    "metadata": {
      "key-b": "field-b-UPDATED", // change field b
      "key-c": "field-c" // new entry
    }
  }
}

Current state of metadata

{
  "account": {
    "id": "test-account",
    "metadata": {
      "key-a": "field-a",
      "key-b": "field-b-UPDATED",
      "key-c": "field-c"
    }
  }
}