Copy as Markdown[View as Markdown](/docs/sdk/functions/addSubDomainToDomain.md)

***

# Function: addSubDomainToDomain()

> **addSubDomainToDomain**(`directory`): (`id`, `subDomain`, `version`?) => `Promise`<`void`>

Defined in: domains.ts:403

Add a subdomain to a domain by it's id. Optionally specify a version to add the subdomain to a specific version of the domain

## Parameters[​](#parameters "Direct link to Parameters")

| Parameter   | Type     |
| ----------- | -------- |
| `directory` | `string` |

## Returns[​](#returns "Direct link to Returns")

`Function`

### Parameters[​](#parameters-1 "Direct link to Parameters")

| Parameter            | Type                                     |
| -------------------- | ---------------------------------------- |
| `id`                 | `string`                                 |
| `subDomain`          | { `id`: `string`; `version`: `string`; } |
| `subDomain.id`       | `string`                                 |
| `subDomain.version`? | `string`                                 |
| `version`?           | `string`                                 |

### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`void`>

## Example[​](#example "Direct link to Example")

```
import utils from '@eventcatalog/utils';

// Adds a subdomain to the given domain
const { addSubDomainToDomain } = utils('/path/to/eventcatalog');

// Adds a subdomain (Payment Domain) to the domain (Orders)
await addSubDomainToDomain('Orders', { service: 'Payment Domain', version: '2.0.0' });
// Adds a subdomain (Inventory Domain) to the domain (Orders) with a specific version
await addSubDomainToDomain('Orders', { service: 'Inventory Domain', version: '2.0.0' }, '1.0.0');
```