Yext Admin API icon

Yext Admin API

Interact with Yext Admin API

Administrative API → Resources Apply Request

AI-generated

Summary

Apply Resources from a specified source repository to a target Yext account by submitting a resource apply request.

Inputs

  • Target Account Id (required) — The ID of the Yext account where the specified resources will be applied.
  • Source (required) — A JSON object describing the source of the resources, including 'type' (e.g., 'GitHub'), 'url' of the repository, and 'variables' used in the resource application.
  • Request Options — Optional settings including batching configuration (items per batch, batch interval), SSL certificate validation behavior, HTTP proxy settings, and request timeout duration in milliseconds.

Output shape

a JSON response from the Yext Admin API indicating the result of the apply resources request

The output shape depends on the Yext Admin API response. The operation sends a POST request with the specified source and target account and returns the API's response. Request options like batching affect how requests are sent but not the direct output shape.

Discussion