---
title: "Create email account mobile profile configuration"
method: GET
path: "/generate_mobileconfig"
tags: ["Mail", "Mail Server Settings"]
---

# Create email account mobile profile configuration

`GET /generate_mobileconfig`

This function generates a mobile configuration profile for an email account.

**Important:**

When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.

## Query parameters

- `account` string, required
- `use_ssl` 0 | 1, required
- `selected_account_services` 'caldav' | 'carddav' | 'email'

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `payload` string, base64 — The function's raw output. This function returns this value as a binary of an Apple mobile configuration file containing a series of sub-tags and keys. For more information, read [Apple's key reference](https://developer.apple.com/business/documentation/Configuration-Profile-Reference.pdf).
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)