Set the account's notification preferences.

Use this function to set the logged in cPanel or Webmail account's notification preferences.

Note:

To set a cPanel account's notification email address, call set_email_addresses. To return the list of account notification preferences you can set with set_notification_preferences, call get_notification_preferences.

SecurityBasicAuth

Request

Request Body schema: application/json

object

Responses

200

Request was successful.

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

post/ContactInformation/set_notification_preferences

Request samples

Payload
CLI
URL

application/json

{"preferences": {"notify_account_authn_link": "0",
"notify_account_login": "1"
}
}

Response samples

application/json

{"apiversion": 3,
"func": "set_notification_preferences",
"module": "ContactInformation",
"result": {"data": [{"additionalProperties": "string",
"descp": "Someone logs in to my account.",
"enabled": 1,
"name": "notify_account_login"
}
],
"errors": null,
"messages": null,
"status": 1,
"warnings": null
}
}