---
title: "Update ADE Settings"
method: PATCH
path: "/api/v2/applemdms/ade_tokens/{adeTokenObjectId}/ade_settings/{osFamily}"
tags: ["mdm"]
---

# Update ADE Settings

`PATCH /api/v2/applemdms/ade_tokens/{adeTokenObjectId}/ade_settings/{osFamily}`

## Request

- Base URL: `https://console.jumpcloud.com`
- URL: `https://console.jumpcloud.com/api/v2/applemdms/ade_tokens/{adeTokenObjectId}/ade_settings/{osFamily}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/v2/applemdms/ade_tokens/:adeTokenObjectId/ade_settings/:osFamily/patch.ts> (a function with typed inputs; its response is checked against the schema)

Create or update ADE settings for an ADE token and OS family. patch_mask is required; only fields listed in patch_mask.fields are updated. Include setup_options or default_device_group_object_ids in fields to clear them.

#### Sample Request
```
curl -X PATCH /applemdms/ade_tokens/{ade_token_object_id}/ade_settings/DARWIN \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key:{API_KEY}' \
  -d '{"enableZeroTouchEnrollment":true,"welcomeScreen":{"title":"Welcome","paragraph":"Set up your device","button":"Continue"},"patchMask":{"fields":["enable_zero_touch_enrollment","welcome_screen.title","welcome_screen.paragraph","welcome_screen.button"]}}'
```

## Path parameters

- `adeTokenObjectId` string, byte, required
- `osFamily` 'UNKNOWN' | 'DARWIN' | 'IOS', required

## Request body

- object
  - `defaultDeviceGroupObjectIds` string[]
  - `enableZeroTouchEnrollment` boolean
  - `patchMask` JumpcloudAppleMdmADESettingPatchMask: ADESettingPatchMask selects which PatchADESettingRequest fields to apply. Required on PatchADESettingRequest. Only fields listed in fields are updated (include setup_options or default_device_group_object_ids in fields to clear them).
    - `fields` string[]
  - `setupOptions` JumpcloudAppleMdmSetupAssistantOption[]
  - `welcomeScreen` JumpcloudAppleMdmWelcomeScreen
    - `button` string
    - `paragraph` string
    - `title` string

## Response `200`

A successful response.

- unknown

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/revisions/f396d9271b46?raw)