Yext Knowledge APIInstall

Summary

Update the configuration of an existing domain in Yext, including SSL certificate settings and ownership transfer if required.

Inputs

• force_move — Boolean to force moving ownership of the domain to this account if the domain is in a MOVE_REQUIRED state.
• update_mask — A JSON-formatted comma-separated list of fields to update on the domain, specifying which fields should be changed.
• managed_ssl — JSON object defining SSL certificate settings where SSL is automatically managed by Yext. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set.
• managed_csr — JSON object defining SSL certificate settings using a managed certificate signing request (CSR). Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set.
• custom_ssl_certificate — JSON object providing a custom SSL certificate and private key to use for the domain. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set.

Output shape

a single record representing the updated domain object

The operation updates domain fields specified by the update_mask and includes SSL certificate details; use force_move to transfer domain ownership if required. Output contains the domain resource with updated values.

Examples

Example 1: Update domain to use a managed SSL certificate and force ownership move if necessary

Set force_move to true, update_mask to include SSL fields, and managed_ssl JSON with certificate authority details.