Disable global address book

This function disables the shared global address book for the current cPanel account's webmail accounts.

Authorizations:
query Parameters
name
string

cPanel account username or a Webmail user's email address. If you do not specify a user, this parameter defaults to the currently-authenticated user.

Example: name=user

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 \
  DAV \
  disable_shared_global_addressbook

Response samples

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