updateDomainWithHttpInfo method

Future<Response> updateDomainWithHttpInfo(
  1. String domainId,
  2. UpdateDomainRequest updateDomainRequest
)

Update a domain

The proxy_url can be updated only for production instances. Update one of the instance's domains. Both primary and satellite domains can be updated. If you choose to use Clerk via proxy, use this endpoint to specify the proxy_url. Whenever you decide you'd rather switch to DNS setup for Clerk, simply set proxy_url to null for the domain. When you update a production instance's primary domain name, you have to make sure that you've completed all the necessary setup steps for DNS and emails to work. Expect downtime otherwise. Updating a primary domain's name will also update the instance's home origin, affecting the default application paths.

Note: This method returns the HTTP Response.

Parameters:

Implementation

Future<http.Response> updateDomainWithHttpInfo(
  String domainId,
  UpdateDomainRequest updateDomainRequest,
) async {
  // ignore: prefer_const_declarations
  final path = r'/domains/{domain_id}'.replaceAll('{domain_id}', domainId);

  // ignore: prefer_final_locals
  Object? postBody = updateDomainRequest;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  const contentTypes = <String>['application/json'];

  return apiClient.invokeAPI(
    path,
    'PATCH',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}