v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
UserManager
Subaccount Management

Unregister service account from Subaccount

This function unlinks a service account from a subaccount.

get/UserManager/unlink_service_account

Query parameters

domainstring domain required
Example:example.com

The subaccount's associated domain.

service'email' | 'ftp' | 'webdisk' required
Example:ftp

The service to unlink.

  • email
  • ftp
  • webdisk
usernamestring username required
Example:example

The subaccount's username.

Note:

This value does not include the domain name.

dismiss0 | 1

Whether to dismiss the service account as a merge candidate.

  • 1 - Dismiss as merge candidate.
  • 0 - Display as merge candidate.

Note:

If any email, FTP, or Web Disk accounts use the same username, cPanel's User Manager interface (cPanel >> Home >> Preferences >> User Manager) allows you to merge those accounts into a subaccount.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "unlink_service_account",
  "module": "UserManager",
  "result": {
    "status": 1
  }
}