Skip to content
Dashboard
API Reference

Update an Entry ​

Change an entry ID, display name, or metadata.

This page documents its request, success response, and error response fields in full.

Request ​

Headers ​

HeaderTypeRequiredAllowed value and meaning
AuthorizationstringYesBearer <Mosaic API key>. The key's organization must own the store.
Content-TypestringYesapplication/json.

Path parameters ​

ParameterTypeRequiredAllowed value and meaning
store_idUUID stringYesMosaic-generated store.id containing the current entry.
entry_idstringYesExact current store-scoped entry ID. URL-encode reserved path characters. The JSON body's entry_id may rename it.

This endpoint has no query parameters.

bash
curl -X PATCH \
  "https://api.mosaic.so/shared-stores/11111111-1111-4111-8111-111111111111/entries/0689B" \
  -H "Authorization: Bearer mk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "entry_id": "0689B",
    "display_name": "Jordan Lee",
    "metadata": { "age": 32, "market": "Austin" }
  }'

entry_id and display_name are required. Omit metadata to preserve its current value.

JSON body ​

FieldTypeRequiredPossible values
entry_idstringYesAny non-empty ID. May equal the ID in the URL or rename it to an unused ID in the same store.
display_namestringYesAny non-empty label after surrounding whitespace is removed.
metadataJSON objectNoAny object up to 256 KB. Omit to preserve the existing object; send null to replace it with {}.

Response ​

200 OK ​

json
{
  "entry": {
    "entry_id": "0689B",
    "display_name": "Jordan Lee",
    "metadata": { "age": 32, "market": "Austin" },
    "created_at": "2026-08-03T20:00:00Z"
  }
}
FieldTypeMeaning and possible values
entryobjectThe complete entry after the update. The object always contains every field listed below.
entry.entry_idstringNew trimmed store-scoped ID accepted from the request. It may remain unchanged or be renamed to an unused ID.
entry.display_namestringNew trimmed non-empty label accepted from the request.
entry.metadataJSON objectResulting metadata object. Omission preserves the previous object; request null produces {}. The response field itself is never null, may contain any JSON values, and is limited to 256 KB.
entry.created_atISO 8601 stringUTC timestamp of initial creation. Updating or renaming the entry preserves it.

Error responses ​

StatusPayloadPossible value
400 Bad Request{ "error": "entry_id and display_name are required" }A required ID or display name is empty.
400 Bad Request{ "detail": "metadata must be a JSON object" }metadata is an array, string, number, or boolean.
401 Unauthorized{ "detail": string }detail is exactly Authorization header must start with Bearer, invalid_api_key, or API key must be associated with an organization.
403 Forbidden{ "detail": "api_access_required" }API access is unavailable for the organization.
404 Not Found{ "error": "Shared store not found" }The store does not exist or belongs to another organization.
404 Not Found{ "error": "Shared store entry not found" }The current entry ID does not exist.
409 Conflict{ "error": "Entry ID already exists in this shared store" }The requested new ID is already in use.
413 Payload Too Large{ "detail": "metadata must be 256 KB or smaller" }UTF-8 encoded metadata exceeds 256,000 bytes.
500 Internal Server Error{ "error": "Failed to rename shared store entry" }The entry could not be updated.