mdm

Update ADE Settings

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"]}}'

patch/applemdms/ade_tokens/{adeTokenObjectId}/ade_settings/{osFamily}

Request

Base URL
https://console.jumpcloud.com/api/v2
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/docs/applemdms/ade_tokens/:adeTokenObjectId/ade_settings/:osFamily/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

adeTokenObjectIdstring byte required

osFamily'UNKNOWN' | 'DARWIN' | 'IOS' required

Request body

defaultDeviceGroupObjectIdsstring[]

enableZeroTouchEnrollmentboolean

setupOptionsJumpcloudAppleMdmSetupAssistantOption[]

Response

A successful response.

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.