Skip to main content

We have added support for mutable records

  • July 3, 2025
  • 0 replies
  • 27 views

Forum|alt.badge.img

Hi,

We have just rolled out “mutability” support for the Records API service. Mutability is the ability to change a record once it has initially been written to the Records API service.

Enabling mutability for a stream requires using the settings.template.name key in the payload of the creation request for a stream. 

I.e. submitting a POST operation to the /streams endpoint, with - for example - the following body:

items: [
externalId: "a-mutable-stream-1",
settings: {
template: {
name: "MutableTestStream"
}
}
]

 

There are two supported “mutable”stream settings templates: “MutableTestStream”, and “MutableLiveData”.

To update or create a record in this stream, you must use the newly introduced upsert endpoint in the Records API and specify the required identifiers of the previously ingested record you’re wanting to update.

Over the next couple of weeks, we would love it if you could spend some time familiarizing yourself with mutable streams, and test record updates to help us understand whether the current API shape for the endpoint is suitable, how well the documentation works for you, and whether there are changes we should make to provide a better development/user experience when using mutable/live record streams. 

Any comments or questions can be added as replies to this “announcement”.