# Add a new Restrictions payload configuration to an existing profile

To create Restrictions policy.

## Endpoint

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

## Request URL

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

## Scope

`MDMDeviceMgmt.CREATE`

## Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

## Request Parameters

### Request Headers

| Name | Type | Required | Value |
|---|---|---|---|
| Content-Type | string | Mandatory | application/json |
| Accept | string | Mandatory | application/json |

### Path Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| 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

Content type: `application/json`

| Attribute | Type | Required | Description |
|---|---|---|---|
| allow_app_installation | boolean | Optional | Allow App Installation. Default: true |
| allow_app_removal | boolean | Optional | Allow App Removal. Default: true |
| allow_use_of_camera | boolean | Optional | Allow Use Of Camera. Default: true |
| allow_face_time | boolean | Optional | Allow Face Time. Default: true |
| allow_airdrop | boolean | Optional | Allow Airdrop. Default: true |
| allow_imessage | boolean | Optional | Allow Imessage. Default: true |
| allow_modifi_passcode | boolean | Optional | Allow Modifi Passcode. Default: true |
| allow_screen_capture | boolean | Optional | Allow Screen Capture. Default: true |
| allow_sync_while_roaming | boolean | Optional | Allow Sync While Roaming. Default: true |
| allow_assistant | boolean | Optional | Allow Assistant. Default: true |
| allow_assistant_when_locked | boolean | Optional | Allow Assistant When Locked. Default: true |
| force_assist_profanity_filter | boolean | Optional | Force Assist Profanity Filter. Default: false |
| allow_assistant_user_content | boolean | Optional | Allow Assistant User Content. Default: true |
| allow_touch_id | boolean | Optional | Allow Touch Id. Default: true |
| allow_passbook_when_locked | boolean | Optional | Allow Passbook When Locked. Default: true |
| show_control_center | boolean | Optional | Show Control Center. Default: true |
| show_notification_center | boolean | Optional | Show Notification Center. Default: true |
| show_today_view | boolean | Optional | Show Today View. Default: true |
| allow_voice_dialing | boolean | Optional | Allow Voice Dialing. Default: true |
| allow_inapp_purchase | boolean | Optional | Allow Inapp Purchase. Default: true |
| force_istore_pwd_entry | boolean | Optional | Force Istore Pwd Entry. Default: false |
| allow_game_center | boolean | Optional | Allow Game Center. Default: true |
| allow_multiplayer_gaming | boolean | Optional | Allow Multiplayer Gaming. Default: true |
| allow_add_game_center_friend | boolean | Optional | Allow Add Game Center Friend. Default: true |
| allow_use_of_youtube | boolean | Optional | Allow Use Of Youtube. Default: true |
| allow_use_of_ibookstore | boolean | Optional | Allow Use Of Ibookstore. Default: true |
| allow_ibookstore_erotica_media | boolean | Optional | Allow Ibookstore Erotica Media. Default: true |
| allow_itunes | boolean | Optional | Allow Itunes. Default: true |
| allow_safari | boolean | Optional | Allow Safari. Default: true |
| safari_allow_autofill | boolean | Optional | Safari Allow Autofill. Default: true |
| safari_force_fraud_warning | boolean | Optional | Safari Force Fraud Warning. Default: false |
| safari_allow_javascript | boolean | Optional | Safari Allow Javascript. Default: true |
| safari_allow_popups | boolean | Optional | Safari Allow Popups. Default: true |
| safari_accept_cookies | integer | Optional | Safari cookie acceptance policy. Allowed values: 0=Never, 1=From current website only, 2=Always. Default: 2 |
| allow_cloud_backup | boolean | Optional | Allow Cloud Backup. Default: true |
| allow_cloud_document_sync | boolean | Optional | Allow Cloud Document Sync. Default: true |
| allow_photo_stream | boolean | Optional | Allow Photo Stream. Default: true |
| allow_shared_stream | boolean | Optional | Allow Shared Stream. Default: true |
| allow_diagnostic_submission | boolean | Optional | Allow Diagnostic Submission. Default: true |
| allow_untrusted_tls_prompt | boolean | Optional | Allow Untrusted Tls Prompt. Default: true |
| allow_ota_pki_updates | boolean | Optional | Allow Ota Pki Updates. Default: true |
| force_encrypted_backup | boolean | Optional | Force Encrypted Backup. Default: false |
| force_limited_ad_tracking | boolean | Optional | Force Limited Ad Tracking. Default: false |
| allow_profile_installation | boolean | Optional | Allow Profile Installation. Default: true |
| allow_account_modification | boolean | Optional | Allow Account Modification. Default: true |
| allow_find_my_friends_mod | boolean | Optional | Allow Find My Friends Mod. Default: true |
| allow_host_pairing | boolean | Optional | Allow Host Pairing. Default: true |
| allow_app_cellular_data | boolean | Optional | Allow App Cellular Data. Default: true |
| allow_open_doc_in_unmanaged | boolean | Optional | Allow Open Doc In Unmanaged. Default: true |
| allow_open_doc_in_managed | boolean | Optional | Allow Open Doc In Managed. Default: true |
| allow_explicit_content | boolean | Optional | Allow Explicit Content. Default: true |
| is_rating_enabled | boolean | Optional | Is Rating Enabled. Default: false |
| country_code | string | Optional | Country Code. Default: us |
| movies_rating_value | integer | Optional | Movie content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=G, 200=PG, 300=PG-13, 400=R, 500=NC-17, 1000=Allow All Movies. Default: 1000 |
| tv_shows_rating_value | integer | Optional | TV show content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=TV-Y, 200=TV-Y7, 300=TV-G, 400=TV-PG, 500=TV-14, 600=TV-MA, 1000=Allow All TV Shows. Default: 1000 |
| apps_rating_value | integer | Optional | App Store content rating filter. Allowed values vary by country. US values: 0=Don't Allow, 100=4+, 200=9+, 300=12+, 600=17+, 1000=Allow All Apps. Default: 1000 |
| allow_managed_app_cloud_sync | boolean | Optional | Allow Managed App Cloud Sync. Default: true |
| allow_managed_book_backup | boolean | Optional | Allow Managed Book Backup. Default: true |
| allow_managed_book_sync | boolean | Optional | Allow Managed Book Sync. Default: true |
| allow_activity_continuation | boolean | Optional | Allow Activity Continuation. Default: true |
| allow_erase_content_settings | boolean | Optional | Allow Erase Content Settings. Default: true |
| allow_enabling_restriction | boolean | Optional | Allow Enabling Restriction. Default: true |
| allow_spotlight_result | boolean | Optional | Allow Spotlight Result. Default: true |
| allow_cloud_keychain_sync | boolean | Optional | Allow Cloud Keychain Sync. Default: true |
| force_airplay_outgoing_pwd | boolean | Optional | Force Airplay Outgoing Pwd. Default: false |
| allow_podcasts | boolean | Optional | Allow Podcasts. Default: true |
| allow_dictionary_lookup | boolean | Optional | Allow Dictionary Lookup. Default: true |
| allow_predictive_keyboard | boolean | Optional | Allow Predictive Keyboard. Default: true |
| allow_auto_correction | boolean | Optional | Allow Auto Correction. Default: true |
| allow_spellcheck | boolean | Optional | Allow Spellcheck. Default: true |
| force_airplay_incoming_pwd | boolean | Optional | Force Airplay Incoming Pwd. Default: false |
| force_watch_wrist_detect | boolean | Optional | Force Watch Wrist Detect. Default: false |
| allow_modify_touch_id | boolean | Optional | Allow Modify Touch Id. Default: true |
| force_airdrop_unmanaged | boolean | Optional | Force Airdrop Unmanaged. Default: false |
| allow_keyboard_shortcut | boolean | Optional | Allow Keyboard Shortcut. Default: true |
| allow_paired_watch | boolean | Optional | Allow Paired Watch. Default: true |
| allow_modifi_device_name | boolean | Optional | Allow Modifi Device Name. Default: true |
| allow_modifi_wallpaper | boolean | Optional | Allow Modifi Wallpaper |
| allow_auto_app_download | boolean | Optional | Allow Auto App Download. Default: true |
| allow_managed_app_trust | boolean | Optional | Allow Managed App Trust. Default: true |
| allow_cloud_photo_lib | boolean | Optional | Allow Cloud Photo Lib. Default: true |
| allow_music_service | boolean | Optional | Allow Music Service. Default: true |
| allow_radio_service | boolean | Optional | Allow Radio Service. Default: true |
| allow_diag_sub_modification | boolean | Optional | Allow Diag Sub Modification. Default: true |
| allow_bluetooth_modification | boolean | Optional | Allow Bluetooth Modification. Default: true |
| allow_dictation | boolean | Optional | Allow Dictation. Default: true |
| force_wifi_whitelisting | boolean | Optional | Force Wifi Whitelisting. Default: false |
| allow_news | boolean | Optional | Allow News. Default: true |
| allow_airprint | boolean | Optional | Allow Airprint. Default: true |
| allow_airprint_credential_storage | boolean | Optional | Allow Airprint Credential Storage. Default: true |
| force_airprint_tls | boolean | Optional | Force Airprint Tls. Default: false |
| allow_airprint_ibeacon_discovery | boolean | Optional | Allow Airprint Ibeacon Discovery. Default: true |
| allow_vpn_creation | boolean | Optional | Allow Vpn Creation. Default: true |
| allow_classroom_remoteview | boolean | Optional | Allow Classroom Remoteview. Default: true |
| force_classroom_auto_join | boolean | Optional | Force Classroom Auto Join. Default: false |
| force_classroom_appdevicelock | boolean | Optional | Force Classroom Appdevicelock. Default: false |
| force_classroom_remoteview | boolean | Optional | Force Classroom Remoteview. Default: false |
| request_to_leave_classroom | boolean | Optional | Request To Leave Classroom. Default: false |
| allow_proximity_for_newdevice | boolean | Optional | Allow Proximity For Newdevice. Default: true |
| authenticate_before_autofill | boolean | Optional | Authenticate Before Autofill. Default: false |
| force_date_time | boolean | Optional | Force Date Time. Default: false |
| time_zone | string | Optional | Time Zone. Default: -- |
| allow_password_autofill | boolean | Optional | Allow Password Autofill. Default: true |
| allow_password_proximity | boolean | Optional | Allow Password Proximity. Default: true |
| allow_password_sharing | boolean | Optional | Allow Password Sharing. Default: true |
| allow_managed_write_unmanaged_contact | boolean | Optional | Allow Managed Write Unmanaged Contact. Default: false |
| allow_unmanaged_read_managed_contact | boolean | Optional | Allow Unmanaged Read Managed Contact. Default: false |
| allow_usb_restriction_mode | boolean | Optional | Allow Usb Restriction Mode. Default: true |
| bluetooth_setting | integer | Optional | Bluetooth setting. Allowed values: 0=Off, 1=On, 2=Not Configured. Default: 2 |
| hotspot_setting | integer | Optional | Personal hotspot setting. Allowed values: 0=Off, 1=On, 2=Not Configured. Default: 2 |
| allow_hotspot_modification | boolean | Optional | Allow Hotspot Modification. Default: true |
| allow_esim_modification | boolean | Optional | Allow Esim Modification. Default: true |
| allow_siri_logging | boolean | Optional | Allow Siri Logging. Default: true |
| allow_continuous_path_keyboard | boolean | Optional | Allow Continuous Path Keyboard. Default: true |
| allow_find_my_friend | boolean | Optional | Allow Find My Friend. Default: true |
| allow_find_my_device | boolean | Optional | Allow Find My Device. Default: true |
| force_wifi_on | boolean | Optional | Force Wifi On. Default: false |
| allow_usb_file_drive | boolean | Optional | Allow Usb File Drive. Default: true |
| allow_system_app_removal | boolean | Optional | Allow System App Removal. Default: true |
| allow_notification_modification | boolean | Optional | Allow Notification Modification. Default: true |
| allow_app_clips | boolean | Optional | Allow App Clips. Default: true |
| allow_apple_personalized_ads | boolean | Optional | Allow Apple Personalized Ads. Default: true |
| allow_cellular_plan_modification | boolean | Optional | Allow Cellular Plan Modification. Default: true |
| allow_file_network_drive_access | boolean | Optional | Allow File Network Drive Access. Default: true |
| allow_shared_device_guest_account | boolean | Optional | Allow Shared Device Guest Account. Default: true |
| allow_nfc | boolean | Optional | Allow Nfc. Default: true |
| allow_unpaired_external_boot_to_recovery | boolean | Optional | Allow Unpaired External Boot To Recovery. Default: false |
| force_on_device_only_dictation | boolean | Optional | Force On Device Only Dictation. Default: false |
| force_on_device_only_translation | boolean | Optional | Force On Device Only Translation. Default: false |
| require_managed_pasteboard | boolean | Optional | Require Managed Pasteboard. Default: false |
| allow_auto_unlock | boolean | Optional | Allow Auto Unlock. Default: true |
| allow_cloud_private_relay | boolean | Optional | Allow Cloud Private Relay. Default: true |
| allow_mail_privacy_protection | boolean | Optional | Allow Mail Privacy Protection. Default: true |
| allow_rapid_security_response_installation | boolean | Optional | Allow Rapid Security Response Installation. Default: true |
| allow_rapid_security_response_removal | boolean | Optional | Allow Rapid Security Response Removal. Default: true |
| allow_live_voicemail | boolean | Optional | Allow Live Voicemail. Default: true |
| allow_iphone_widgets_on_mac | boolean | Optional | Allow Iphone Widgets On Mac. Default: true |
| allow_marketplace_app_installation | boolean | Optional | Allow Marketplace App Installation. Default: true |
| allow_web_distribution_app_installation | boolean | Optional | Allow Web Distribution App Installation. Default: true |
| allow_genmoji | boolean | Optional | Allow Genmoji. Default: True |
| allow_image_playground | boolean | Optional | Allow Image Playground. Default: True |
| allow_image_wand | boolean | Optional | Allow Image Wand. Default: True |
| allow_iphone_mirroring | boolean | Optional | Allow Iphone Mirroring. Default: True |
| allow_personalized_handwriting_results | boolean | Optional | Allow Personalized Handwriting Results. Default: True |
| allow_writing_tools | boolean | Optional | Allow Writing Tools. Default: True |
| allow_external_intelligence_integrations | boolean | Optional | Allow External Intelligence Integrations. Default: True |
| force_delayed_software_updates | boolean | Optional | Force Delayed Software Updates. Default: False |
| software_update_delay | long | Optional | Software Update Delay. Default: 30 |
| allow_external_intelligence_integrations_signin | boolean | Optional | Allow External Intelligence Integrations Signin. Default: True |
| allow_mail_summary | boolean | Optional | Allow Mail Summary. Default: True |
| allow_notes_transcription_summary | boolean | Optional | Allow Notes Transcription Summary. Default: True |
| allow_external_intelligence_workspace_ids | string | Optional | Allow External Intelligence Workspace Ids |
| allow_default_browser_modification | boolean | Optional | Allow Default Browser Modification. Default: True |
| allow_safari_private_browsing | boolean | Optional | Allow Safari Private Browsing. Default: True |
| allow_safari_history_clearing | boolean | Optional | Allow Safari History Clearing. Default: True |
| allowed_camera_restriction_app_id | array | Optional | List of app IDs (long) allowed to use the camera when camera is restricted. Use the app_group_id from the [Apps API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/app-management-get-an-app.html) response. |
| default_browser_app_details | JSON Object | Optional | Default Browser App Details |
| default_calling_app_details | JSON Object | Optional | Default Calling App Details |
| default_messaging_app_details | JSON Object | Optional | Default Messaging App Details |
| allow_rcs_messaging | boolean | Optional | Allow Rcs Messaging. Default: True |
| allow_call_recording | boolean | Optional | Allow Call Recording. Default: True |
| allow_apps_to_be_locked | boolean | Optional | Allow Apps To Be Locked. Default: True |
| allow_apps_to_be_hidden | boolean | Optional | Allow Apps To Be Hidden. Default: True |
| allow_visual_intelligence_summarization | boolean | Optional | Allow Visual Intelligence Summarization. Default: True |
| allow_apple_intelligence_report | boolean | Optional | Allow Apple Intelligence Report. Default: True |
| allow_mail_smart_replies | boolean | Optional | Allow Mail Smart Replies. Default: True |
| allow_safari_summary | boolean | Optional | Allow Safari Summary. Default: True |
| allow_default_calling_app_modification | boolean | Optional | Allow Default Calling App Modification. Default: True |
| allow_default_messaging_app_modification | boolean | Optional | Allow Default Messaging App Modification. Default: True |

## Sample Request

```bash
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/restrictionspolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"allow_app_installation":true,"allow_face_time":true,"allow_assistant":true,"allow_modifi_passcode":true,"allow_use_of_camera":true,"allow_app_removal":true,"allow_airdrop":true,"allow_screen_capture":true,"allow_imessage":true,"allow_sync_while_roaming":true}'
```

## Sample Request Body

Add Restrictions payload to the profile.

```json
{
  "allow_app_installation": true,
  "allow_face_time": true,
  "allow_assistant": true,
  "allow_modifi_passcode": true,
  "allow_use_of_camera": true,
  "allow_app_removal": true,
  "allow_airdrop": true,
  "allow_screen_capture": true,
  "allow_imessage": true,
  "allow_sync_while_roaming": true
}
```

## Response Parameters

### HTTP Code 200

Response body content type: `application/json`

The response contains `payload_id` and all Restrictions payload attributes listed in the request body.

| Attribute | Type | Description |
|---|---|---|
| payload_id | long | Unique identifier for the created payload item |
| allow_app_installation | boolean | Allow App Installation. Default: true |
| allow_app_removal | boolean | Allow App Removal. Default: true |
| allow_use_of_camera | boolean | Allow Use Of Camera. Default: true |
| allow_face_time | boolean | Allow Face Time. Default: true |
| allow_airdrop | boolean | Allow Airdrop. Default: true |
| allow_imessage | boolean | Allow Imessage. Default: true |
| allow_modifi_passcode | boolean | Allow Modifi Passcode. Default: true |
| allow_screen_capture | boolean | Allow Screen Capture. Default: true |
| allow_sync_while_roaming | boolean | Allow Sync While Roaming. Default: true |
| allow_assistant | boolean | Allow Assistant. Default: true |

### Possible Response Codes

| Code | Type |
|---|---|
| 200 | HTTP code |

## Sample Response: HTTP 200

Restrictions payload successfully added.

```json
{
  "payload_id": 9007199254741000,
  "allow_app_installation": true,
  "allow_face_time": true,
  "allow_assistant": true,
  "allow_modifi_passcode": true,
  "allow_use_of_camera": true,
  "allow_app_removal": true,
  "allow_airdrop": true,
  "allow_screen_capture": true,
  "allow_imessage": true,
  "allow_sync_while_roaming": true
}
```

## Rate Limit

**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.