Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Listings → Invite Admins

AI-generated

Summary

Invite admins to a specific publisher under a Yext account by sending their invitation details in the request body.

Inputs

  • Account Id (required) — The unique identifier of the Yext account to which the publisher belongs.
  • V (required) — The API version date in YYYYMMDD format for the request.
  • Publisher Id (required) — The unique identifier of the publisher to which admins are invited.
  • Body (required) — A JSON object containing the invitation details for the admins to be invited.

Output shape

a single JSON response object

The response returns JSON data from the Yext Knowledge API reflecting the outcome of the invite admins request. The structure depends on Yext's API response; errors or operation results will be included accordingly.

Examples

Example 1: Invite one or more admins to a publisher

Provide Account Id, Publisher Id, API version date (v), and a JSON body defining the admins to invite.

Discussion