Skip to main content
Anchor to AnalyticsAnnotationUpdatePayload

AnalyticsAnnotationUpdatePayload

payload

Return type for analyticsAnnotationUpdate mutation.

Anchor to FieldsFields

Anchor to analyticsAnnotationanalyticsAnnotation
•AnalyticsAnnotation

The updated analytics annotation.

Anchor to userErrorsuserErrors
•[AnalyticsAnnotationUpdateUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

Anchor to analyticsAnnotationUpdateanalyticsAnnotationUpdate
•mutation

Updates an existing analytics annotation. Only the fields provided in the input argument are modified; omitted fields remain unchanged. Setting endedAt to null makes the annotation open-ended.

An app can update only annotations that it created. If an app attempts to update an annotation that it didn't create, then the mutation returns a NOT_FOUND error.

Use analyticsAnnotationCreate to create a new annotation, or analyticsAnnotationDelete to remove it.

If provided, the type field must specify a supported type for app-created annotations. Refer to the list of supported types.

Arguments

Anchor to idid
•ID!
required

The ID of the analytics annotation to update.

Anchor to inputinput
•AnalyticsAnnotationUpdateInput!
required

The input fields for updating the analytics annotation.

Was this section helpful?