TRMNL Octri Demo
PATCH/api/mashups/{id}

Change the sections of a mashup

Updates the sections of a mashup and optionally its health notification setting. Use contents to map positions to plugin setting IDs; positions you omit keep their current plugin setting. The mashup layout determines which positions are available.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
idintegerrequired
The unique identifier of the mashup to update.

Mashup section assignments and health notification settings.

contentsobjectoptional
Plugin setting id by position
health_notification_enabledbooleanoptional
Whether health notifications are enabled for the mashup.

4 status codes
200Returns the updated mashup data, including its contents, layout, positions, and health notification setting.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
404Returned when the mashup belongs to another user.
422Returned when a specified position does not exist in the mashup layout.

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the mashup belongs to another user. The id path parameter identifies the mashup to update. A 422 is returned when contents specifies a position that the layout does not have; each contents value must be a plugin setting ID.