Skip to main content
PUT
Update Event

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Path Parameters

id
string
required

Query Parameters

fields
string

Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Unknown names return 400.

Body

personId
string
noteId
string
propertyId
string
message
string
description
string
source
string
system
string
type
string
pageTitle
string
pageUrl
string
pageReferrer
string
pageDuration
number
occurredAt
string
additionalAttributes
any
property
object

Response

Response for status 200

id
string
required
personId
string | null

Present unless the request's fields leaves it out.

noteId
string | null

Present unless the request's fields leaves it out.

propertyId
string | null

Present unless the request's fields leaves it out.

created
string

Present unless the request's fields leaves it out.

updated
string

Present unless the request's fields leaves it out.

rolloutUpdated
string

Present unless the request's fields leaves it out.

occurredAt
string | null

Present unless the request's fields leaves it out.

message
string

Present unless the request's fields leaves it out.

description
string

Present unless the request's fields leaves it out.

source
string

Present unless the request's fields leaves it out.

system
string

Present unless the request's fields leaves it out.

type
string

Present unless the request's fields leaves it out.

pageTitle
string

Present unless the request's fields leaves it out.

pageUrl
string

Present unless the request's fields leaves it out.

pageReferrer
string

Present unless the request's fields leaves it out.

pageDuration
number | null

Present unless the request's fields leaves it out.

property
object | null

Present unless the request's fields leaves it out.

propertySearch
object | null

Present unless the request's fields leaves it out.

additionalAttributes
object | null

Present unless the request's fields leaves it out.

originalIds
object

Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.