Yext Admin API icon

Yext Admin API

Interact with Yext Admin API

Administrative API → Cancel All Sub Account Services

AI-generated

Summary

Cancel all services associated with a specific Yext sub account by providing the sub account ID and optionally an agreement ID.

Inputs

  • Sub Account Id (required) — The unique identifier of the sub account for which all services will be canceled.
  • Agreement Id — The ID of the agreement under which services should be canceled; typically not required unless handling advanced scenarios.

Output shape

a JSON object representing the API response after attempting to cancel all sub account services

The output reflects the result returned by the Yext Admin API's 'Cancel All Sub Account Services' endpoint. This operation supports standard request options such as batching, proxy, timeout, and SSL validation settings configured at the node level.

Discussion