Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Optimization Tasks → Get Link Optimization Task

AI-generated

Summary

Retrieve a URL for a Link Optimization Task that prompts users to complete or review specified optimization tasks for given locations, filtered by task IDs and location ID, and controlled by the mode parameter.

Inputs

  • Task Ids — Comma-separated list of Optimization Task IDs to include in the response. Defaults to all Optimization Tasks if omitted.
  • Location Id — Location ID used to filter the tasks. Defaults to all locations if omitted.
  • Mode — Specifies which tasks the link will include: 'PENDING_ONLY' for tasks pending or in progress, 'ALL_TASKS' to include all tasks allowing updates on completed ones, or 'RESET' to reset the tasks.

Output shape

a JSON object containing a link (URL) to the specified optimization tasks, suitable for directing users to complete or update optimization tasks in Yext.

If no Task Ids or Location Id are provided, the link covers all relevant tasks and locations in the account. Mode impacts which tasks appear in the user link. Additional request options such as batching, proxy, timeout, and SSL handling can be configured but do not affect output shape.

Discussion