Yext Admin API icon

Yext Admin API

Interact with Yext Admin API

Administrative API → Cancel Services

AI-generated

Summary

Cancel one or more active services associated with a specific location in the Yext system.

Inputs

  • Location Id (required) — Specify the unique identifier of the location whose services should be canceled.
  • Location Account Id — In Partner Portal mode, specify the account ID where the location that will receive the service resides.
  • Agreement Id — Optionally specify the agreement ID that the cancellation applies to, mainly for advanced scenarios.
  • Skus — Provide a JSON array of SKU strings representing the specific services to cancel. If omitted, all active services for the location will be canceled.

Output shape

a single JSON object containing the API response from the Yext Admin API indicating success or failure of the cancellation request.

The response includes details about the canceled services. The node handles one request per execution based on the provided input parameters. No pagination applies.

Discussion