# OrganizationDomainsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteOrganizationDomain**](#deleteorganizationdomain) | **DELETE** /organization/domain | Remove the organization\'s custom domain|
|[**getOrganizationDomain**](#getorganizationdomain) | **GET** /organization/domain | Get the organization\'s custom domain|
|[**updateOrganizationDomain**](#updateorganizationdomain) | **PUT** /organization/domain | Set the organization\'s custom domain|

# **deleteOrganizationDomain**
> CreateAccountInvitations200Response deleteOrganizationDomain()

Removes the organization\'s configured custom domain, deleting the associated records (including any www subdomain) from Vercel and clearing the domain on the organization; requires the \"update\" permission on \"org\".

### Example

```typescript
import {
    OrganizationDomainsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new OrganizationDomainsApi(configuration);

const { status, data } = await apiInstance.deleteOrganizationDomain();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**CreateAccountInvitations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getOrganizationDomain**
> GetOrganizationDomain200Response getOrganizationDomain()

Returns the custom domain configured for the organization along with its verification/DNS status from the hosting provider, or null if no domain is configured; requires read access to the organization.

### Example

```typescript
import {
    OrganizationDomainsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new OrganizationDomainsApi(configuration);

const { status, data } = await apiInstance.getOrganizationDomain();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**GetOrganizationDomain200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **updateOrganizationDomain**
> UpdateOrganizationDomain200Response updateOrganizationDomain(updateOrganizationDomainRequest)

Configures a custom domain for the organization by registering it (and its www subdomain, unless it is itself a subdomain) with Vercel, then saves the domain on the organization record; fails if a domain is already set or the domain is invalid, and requires the \"update\" permission on \"org\".

### Example

```typescript
import {
    OrganizationDomainsApi,
    Configuration,
    UpdateOrganizationDomainRequest
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new OrganizationDomainsApi(configuration);

let updateOrganizationDomainRequest: UpdateOrganizationDomainRequest; //

const { status, data } = await apiInstance.updateOrganizationDomain(
    updateOrganizationDomainRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **updateOrganizationDomainRequest** | **UpdateOrganizationDomainRequest**|  | |


### Return type

**UpdateOrganizationDomain200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)