# Add a new CardDAV payload configuration to an existing profile

To create Carddav policy

## Endpoint

`POST /api/v1/mdm/profiles/{profile_id}/payloads/carddavpolicy`

## Request URL

`https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/carddavpolicy`

## Scope

`MDMDeviceMgmt.CREATE`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Content-Type** `string` — **Mandatory** — `application/json`
- **Accept** `string` — **Mandatory** — `application/json`

### Path Parameters

- **profile_id** `string` — **Mandatory**
  - Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-get-profile.html) response

### Request Body

`application/json`

- **account_display_name** `string` — Optional
  - Account Display Name
- **account_hostname** `string` — **Mandatory**
  - Account Hostname
- **account_port** `integer` — **Mandatory**
  - Account Port. Default: 8843
- **principal_url** `string` — Optional
  - Principal Url
- **account_username** `string` — Optional
  - Account Username
- **account_password** `string` — Optional
  - Account Password (sensitive - write-only)
- **account_password_id** `long` — Optional
  - Account Password Id
- **use_ssl** `boolean` — Optional
  - Use Ssl. Default: true

## Sample Request

```curl
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/carddavpolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"account_hostname":"https://zylker.com","account_password":"********","principal_url":"https://zylker.com","account_display_name":"Zylker User","use_ssl":true,"account_username":"Zylker User","account_password_id":1,"account_port":8843}'
```

## Sample Request Body

Add CardDAV payload to the profile

```json
{
  "account_hostname": "https://zylker.com",
  "account_password": "********",
  "principal_url": "https://zylker.com",
  "account_display_name": "Zylker User",
  "use_ssl": true,
  "account_username": "Zylker User",
  "account_password_id": 1,
  "account_port": 8843
}
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

- **payload_id** `long`
  - Unique identifier for the created payload item
- **account_display_name** `string`
  - Account Display Name
- **account_hostname** `string`
  - Account Hostname
- **account_port** `integer`
  - Account Port. Default: 8843
- **principal_url** `string`
  - Principal Url
- **account_username** `string`
  - Account Username
- **account_password** `string`
  - Account Password (sensitive - write-only)
- **account_password_id** `long`
  - Account Password Id
- **use_ssl** `boolean`
  - Use Ssl. Default: true

## Possible Response Codes

- **200** `HTTP code`

## Sample Response: HTTP 200

CardDAV payload successfully added

```json
{
  "payload_id": 9007199254741000,
  "account_hostname": "https://zylker.com",
  "account_password": "********",
  "principal_url": "https://zylker.com",
  "account_display_name": "Zylker User",
  "use_ssl": true,
  "account_username": "Zylker User",
  "account_password_id": 1,
  "account_port": 8843
}
```

## Rate Limits

![](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.