Choose a version:

automationTestEventUpdate

mutation

Requires write_automations access scope. Also: The app must have write access to automations and act on behalf of a user.

Renames a test event or replaces its trigger parameters. Updating a captured test event converts it to custom and counts toward the custom test event limit.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the test event to update.
Anchor to namename •String: The new name of the test event. Omit to leave it unchanged.
Anchor to triggerParamstriggerParams •JSON: The trigger parameters that replace the test event's current ones. Must be a JSON object. Omit to leave them unchanged.

Was this section helpful?

Anchor to AutomationTestEventUpdatePayload returnsAutomationTestEventUpdatePayload returns

Anchor to testEventtestEvent •AutomationTestEvent: The updated test event. Returns null if the test event couldn't be updated.

Show fields
Anchor to userErrorsuserErrors •[AutomationTestEventUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

automationTestEventUpdate reference

Mutation Reference

mutation automationTestEventUpdate($id: ID!, $name: String, $triggerParams: JSON) {

automationTestEventUpdate(id: $id, name: $name, triggerParams: $triggerParams) {

testEvent {

# AutomationTestEvent fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/AutomationTestEvent/10079785100",

"name": "<your-name>",

"triggerParams": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }"

}