cPanel API 2 Functions - CSVImport::sendcontact
Warning:
The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
Description
This function is deprecated and does not return useful output.
Warning:
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
Examples
WHM API (JSON)
This function is deprecated.
Note:
For more information, read our Calls from the WHM API documentation.
LiveAPI PHP Class
This function is deprecated.
Note:
For more information, read our Guide to the LiveAPI System.
LiveAPI Perl Module
This function is deprecated.
Note:
For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
Warnings:
- cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our Deprecated cPanel Tag Usage documentation.
Command Line
This function is deprecated.
Notes:
- You must URI-encode values.
-
username
represents your account-level username. -
You
must
include the
--user=username
option. -
For more information and additional output options, read our
Guide to cPanel API 2
documentation or run the
cpapi2 --help
command. -
If you run CloudLinux™, you
must
use the full path of the
cpapi2
command:/usr/local/cpanel/bin/cpapi2
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "sendcontact",
"data": [
],
"event": {
"result": 1
},
"module": "CSVImport"
}
}
Note:
Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
This function does not accept parameters.
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
result |
Boolean | Whether the function succeeded. |
|
1 |