v3

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-08-014669239.7 KB

Observations

Update Observation

Update a specific transient observation by its ID. Only provided fields will be updated. The updated timestamp will be automatically set. This allows for selective updates without needing to provide all fields.

patch/v1/Stores/{storeId}/Profiles/{profileId}/Observations/{observationId}

Request body

contentstring required

The main content of the observation.

occurredAtstring date-time required

The timestamp when the observation originally occurred.

sourcestring required

The source system that generated this observation. Allows letters, numbers, spaces, and URL-safe symbols. Excludes URL-unsafe characters like quotes, angle brackets, and control characters.

conversationIdsConversationID[]

Array of conversation IDs associated with this observation.

Example request

{
  "content": "Customer expressed satisfaction with recent product update during support call.",
  "occurredAt": "2025-01-15T10:15:30Z",
  "source": "conversational-intelligence",
  "conversationIds": [
    "conv_conversation_00000000000000000000000000"
  ]
}

Response

Observation update accepted and is being processed.

messagestring required

Example response

{
  "message": "Observation update accepted"
}