--- title: "Update Trigger" method: PATCH path: "/workflows/triggers/{id}" tags: ["Workflows::Trigger"] --- # Update Trigger `PATCH /workflows/triggers/{id}` Update an existing workflow trigger. All fields optional. An invalid `event_type_key` returns 422. ## Path parameters - `id` string, required ## Request body - WorkflowsTriggerParametersUpdate — Parameters for updating an existing trigger. All fields optional. Condition FK fields accept either the integer id or obfuscated `public_id` string for a resource in the same workspace/team scope. - `workflows_trigger` object, required - `event_type_key` '$appointments.appointment_scheduled' | '$calendar_event.contact_registered' | '$community.join' | '$community.group_join' | '$community.topic_join' | '$community.post' | '$community.ban' | '$community.unban' | '$community.post_view' | '$contact.tag_applied' | '$contact.tag_removed' | '$course.complete' | '$course.enroll' | '$course.unenroll' | '$course.lesson_complete' | '$course.lesson_view' | '$course.section_complete' | '$email.bounce' | '$email.click' | '$email.open' | '$email.sent' | '$email.spam_complaint' | '$send_email_step.bounce' | '$send_email_step.click' | '$send_email_step.open' | '$send_email_step.sent' | '$send_email_step.spam_complaint' | '$order.successful_purchase' | '$order.cancelled' | '$order.churned' | '$subscription.upgraded' | '$subscription.downgraded' | '$transaction.renewal_failed' | '$sales.contact_entered_stage' | '$sales.contact_exited_stage' | '$optin' | '$view' | '$message_hub_event.contact_conversation_started' | '$message_hub_event.agent_conversation_started' | '$message_hub_event.contact_responded' | '$message_hub_event.agent_responded' | '$survey.complete' — New event key. Must be one of the enumerated keys; an invalid key returns 422. - `active` boolean - `allow_anonymous_contacts` boolean - `subscription_cancelation_reason` string - `contacts_tag_id` union — Integer database id or obfuscated public_id. - integer - string - `funnel_id` union — Integer database id or obfuscated public_id. - integer - string - `page_id` union — Integer database id or obfuscated public_id. - integer - string - `product_id` union — Integer database id or obfuscated public_id. - integer - string - `cancellation_product_id` union — Integer database id or obfuscated public_id. - integer - string - `product_variant_id` union — Integer database id or obfuscated public_id. - integer - string - `cancellation_product_variant_id` union — Integer database id or obfuscated public_id. - integer - string - `subscription_variant_to_id` union — Integer database id or obfuscated public_id. - integer - string - `sales_pipelines_id` union — Integer database id or obfuscated public_id. - integer - string - `current_sales_pipelines_stage_id` union — Integer database id or obfuscated public_id. - integer - string - `appointments_calendar_id` union — Integer database id or obfuscated public_id. - integer - string - `appointments_event_type_id` union — Integer database id or obfuscated public_id. - integer - string - `course_id` union — Integer database id or obfuscated public_id. - integer - string - `courses_lesson_id` union — Integer database id or obfuscated public_id. - integer - string - `courses_section_id` union — Integer database id or obfuscated public_id. - integer - string - `community_id` union — Integer database id or obfuscated public_id. - integer - string - `communities_space_id` union — Integer database id or obfuscated public_id. - integer - string - `communities_space_group_id` union — Integer database id or obfuscated public_id. - integer - string - `emails_broadcasts_id` union — Integer database id or obfuscated public_id. - integer - string - `calendar_event_id` union — Integer database id or obfuscated public_id. - integer - string - `survey_workflow_id` union — Integer database id or obfuscated public_id. - integer - string - `workflows_step_id` union — Integer database id or obfuscated public_id. - integer - string ## Response `200` OK - WorkflowsTriggerAttributes — A trigger attached to a workflow. Each trigger has an `event_type_key` (e.g. `$contact.tag_applied`) and optional condition FK ids that narrow when the trigger fires. An invalid `event_type_key` returns 422. NOTE: for site events (`$optin`, `$view`) scope by `page_id` — these events are not associated with a funnel, so a `funnel_id` condition silently never matches. - `id` integer — Trigger ID - `public_id` string, nullable — Obfuscated trigger ID - `workflow_id` integer — Integer ID of the parent workflow - `event_type_key` string, nullable — The event that fires this trigger (e.g. `$contact.tag_applied`, `$order.successful_purchase`). - `event_type_name` string, nullable — Human-readable name of the event type. - `active` boolean — Whether the trigger is active and will enroll contacts. - `allow_anonymous_contacts` boolean — Whether the trigger fires for anonymous (non-identified) contacts. - `subscription_cancelation_reason` string, nullable — Only set on `$order.cancelled` (subscription cancellation) triggers — the cancellation-reason token the contact selected (e.g. `too_expensive`). `null` for every other event type. - `contacts_tag_id` integer, nullable — Raw integer Contacts::Tag id used as a condition filter. - `funnel_id` integer, nullable — Raw integer Funnel id used as a condition filter. - `page_id` integer, nullable — Raw integer Page id used as a condition filter. - `product_id` integer, nullable — Raw integer Product id used as a condition filter. - `cancellation_product_id` integer, nullable — Raw integer Product id for cancellation condition filtering. - `product_variant_id` integer, nullable — Raw integer Products::Variant id used as a condition filter. - `cancellation_product_variant_id` integer, nullable — Raw integer Products::Variant id for cancellation condition filtering. - `subscription_variant_to_id` integer, nullable — Raw integer Products::Variant id for subscription upgrade/downgrade triggers. - `sales_pipelines_id` integer, nullable — Raw integer Sales::Pipeline id used as a condition filter. - `current_sales_pipelines_stage_id` integer, nullable — Raw integer Sales::Pipelines::Stage id used as a condition filter. - `appointments_calendar_id` integer, nullable — Raw integer Appointments::Calendar id used as a condition filter. - `appointments_event_type_id` integer, nullable — Raw integer Appointments::EventType id used as a condition filter. - `course_id` integer, nullable — Raw integer Course id used as a condition filter. - `courses_lesson_id` integer, nullable — Raw integer Courses::Lesson id used as a condition filter. - `courses_section_id` integer, nullable — Raw integer Courses::Section id used as a condition filter. - `community_id` integer, nullable — Raw integer Community id used as a condition filter. - `communities_space_id` integer, nullable — Raw integer Communities::Space id used as a condition filter. - `communities_space_group_id` integer, nullable — Raw integer Communities::SpaceGroup id used as a condition filter. - `emails_broadcasts_id` integer, nullable — Raw integer Emails::Broadcast id used as a condition filter. - `calendar_event_id` integer, nullable — Raw integer CalendarEvent id used as a condition filter. - `survey_workflow_id` integer, nullable — Raw integer SurveyWorkflow id used as a condition filter. - `workflows_step_id` integer, nullable — Raw integer Workflows::Step id used as a condition filter. - `created_at` string, date-time - `updated_at` string, date-time ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `422` — Unprocessable Entity --- [API](https://skmtc.net/myclickfunnels/apis/clickfunnels-api.md) · [All operations](https://skmtc.net/myclickfunnels/apis/clickfunnels-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myclickfunnels/clickfunnels-api/versions/ae6313eaa176/schema)