Actions176
- Health Check Actions
- Knowledge Manager Actions
- List Entities
- Create Entity
- Get Entity
- Update Entity
- Delete Entity
- List Language Profiles
- List All Language Profiles
- Get Language Profile
- Upsert Language Profile
- Delete Language Profile
- Get Locations
- Create Location
- Search Locations
- Get Location
- Update Location
- Get Location Folders
- Get Menus
- Create Menu
- Get Menu
- Update Menu
- Delete Menu List
- Get Bios
- Create Bio
- Get Bio
- Update Bio
- Delete Bio List
- Get Products
- Create Product
- Get Product
- Update Product
- Delete Product List
- Get Events
- Create Event
- Get Event
- Update Event
- Delete Event List
- Get Business Categories
- Get Google Keywords
- Get Custom Fields
- Create Custom Field
- Get Custom Field
- Update Custom Field
- Delete Custom Field
- Get Language Profiles
- Get Location Language Profile
- Upsert Location Language Profile
- Delete Location Language Profile
- List Assets
- Create Asset
- Get Asset
- Update Asset
- Delete Asset
- Upsert Suggestion
- List Suggestions
- Cancel Suggestion
- Get Suggestion
- Comment Suggestion
- Update Suggestion
- Listings Actions
- List Publishers
- List Listings
- Opt In Listings
- Opt Out Listings
- Confirm Sync Listings
- Force Sync Listings
- List Publisher Suggestions
- Get Publisher Suggestion
- Update Publisher Suggestion
- List Duplicates
- Create Duplicate
- Delete Duplicate
- Suppress Duplicate
- List Methods
- List Statuses
- Initiate Verification
- Complete Verification
- List Admins
- Invite Admins
- List Entity Listings
- Delete Listings
- List Questions
- Get Question
- Create Answer
- Update Answer
- Delete Answer
- Analytics Actions
- Logs API Actions
- Reviews Actions
- Social Actions
- Account Settings Actions
- Optimization Tasks Actions
- Connectors Actions
- Configuration Actions
- Licenses Actions
- Computations Actions
- Domains Actions
Connectors → Trigger Connector
AI-generatedSummary
Trigger a Connector by specifying its ID to initiate a run with a chosen run mode and optional dry run flag.
Inputs
- Connector Id (required) — Specify the unique identifier of the Connector to trigger.
- Run Mode — Select the mode for the Connector run: DEFAULT, COMPREHENSIVE, or DELETION.
- Dry Run — Choose whether to execute a dry run without making actual changes.
- Request Options — Optionally configure request behavior such as batching, SSL certificate verification, proxy, and timeout settings.
Output shape
a JSON response object representing the result of triggering the Connector.
The output shape is the HTTP response body from the Yext Knowledge API that reflects the Connector triggering result. No pagination applies. Errors will be thrown on failure.
Examples
Example 1: Trigger Connector with defaults
Connector Id set to a valid ID, Run Mode at default (DEFAULT), Dry Run false, default Request Options.