# Initiate AD synchronization for a domain

Initiates an immediate AD synchronization for a specific domain. Returns whether the sync was successfully started or is already in progress.

## Endpoints

`POST /dcapi/som/domains/{domain_id}/sync`

## Request URL

`https://{server-hostname}:8383/dcapi/som/domains/{domain_id}/sync`

## Scope

`SOM.CREATE`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

| Parameter | Type | Required | Value |
|---|---|---|---|
| Accept | string | Mandatory | `application/domainTreeSyncStatus.v1+json` |

### Path Parameters

| Parameter | Type | Required |
|---|---|---|
| domain_id | string | Mandatory |

## Sample Request

```curl
curl --request POST \
  --url https://appdomain/dcapi/som/domains/{domain_id}/sync \
  --header 'Accept: application/domainTreeSyncStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 202

**Response Body:** `application/json`

**JSON Object**

| Attribute | Type | Description |
|---|---|---|
| isDomainAdSyncInProgress | boolean | Indicates whether the Active Directory synchronization process is now running for this domain |
| status | boolean | Indicates whether the synchronization request was accepted and initiated successfully |
| message | string | Descriptive message confirming the sync initiation or explaining why it could not be started (e.g., 'Domain sync is already in progress') |

### HTTP Code 412

**Response Body:** `application/json`

**JSON Object**

| Attribute | Type | Description |
|---|---|---|
| statusCode | string | HTTP status code (412) |
| errorCode | string | Precondition failed error code identifying the business logic violation |
| message | string | Error message describing the precondition failed while processing request |

## Possible Response Codes

| HTTP Code |
|---|
| 202 |
| 412 |

## Sample Response: HTTP 202

Sync initiated successfully

```json
{
  "message": "Domain sync initiated for ECSOM",
  "isDomainAdSyncInProgress": true,
  "status": true
}
```

## Sample Response: HTTP 412

Domain sync is already in progress

```json
{
  "errorCode": "10015",
  "message": "AD Domain Sync is already in progress. Sync attempt failed.",
  "statusCode": 412
}
```

Daily sync limit reached

```json
{
  "errorCode": "30104",
  "message": "Reached daily limit to initiate domain Sync",
  "statusCode": 412
}
```

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**Duration:** 1 minute | **Threshold:** 30 | **Lock period:** 5 minutes

Duration - Time window for the threshold.  
Threshold - Number of API calls allowed within the specified duration.  
Lock Period - Wait time before consecutive API requests.