Remove service account link request

This function removes a service account as a link candidate to create a subaccount or link to a subaccount. When you use this function, the system removes the Link option in cPanel's User Manager interface (cPanel >> Home >> Preferences >> User Manager).

Note:

You must use at least one of the following parameters:

  • services.email.dismiss
  • services.ftp.dismiss
  • services.webdisk.dismiss
Authorizations:
query Parameters
domain
required
string <domain>

The service account's associated domain.

Example: domain=example.com
username
required
string <username> <= 64 characters

The username for the service account.

Note:

This parameter does not include the domain name.

Example: username=example1
services.email.dismiss
integer
Default: 0

Whether to dismiss the merge of the email service account.

  • 1 - Dismiss.
  • 0 - Do not dismiss.
Enum: 0 1
Example: services.email.dismiss=1
services.ftp.dismiss
integer
Default: 0

Whether to dismiss the merge of the FTP service account.

  • 1 - Dismiss.
  • 0 - Do not dismiss.
Enum: 0 1
Example: services.ftp.dismiss=1
services.webdisk.dismiss
integer
Default: 0

Whether to dismiss the merge of the Web Disk service account.

  • 1 - Dismiss.
  • 0 - Do not dismiss.
Enum: 0 1
Example: services.webdisk.dismiss=1

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  UserManager \
  dismiss_merge \
  username='example1' \
  domain='example.com'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "dismiss_merge",
  • "module": "UserManager",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}