Syntax
bool setFieldFolderId(
string api_key,
int list_id,
int field_id,
int folder_id
);
Parameters
api_key(string)The key required to access the API. See Getting Started for more information.
list_id(int)The List ID of the Field.
field_id(int)The Field ID.
folder_id(int)The Folder ID for the Field.
Return Value
Returns true on success.
Examples
$api = new Api($url, 'YOURAPIKEY');
// Set ID's required
$list_id = 123;
$field_id = 456;
$folder_id = 789;
$result = $api->invokeMethod('setFieldFolderId', $list_id, $field_id, $folder_id);
// Set ID's required
$list_id = 123;
$field_id = 456;
$folder_id = 789;
$result = $api->invokeMethod('setFieldFolderId', $list_id, $field_id, $folder_id);
{
"id": 1,
"method": "setFieldFolderId",
"params": [
"YOURAPIKEY",
123,
456,
789
]
}
"id": 1,
"method": "setFieldFolderId",
"params": [
"YOURAPIKEY",
123,
456,
789
]
}
{
"id": 1,
"result": true,
"error": null
}
"id": 1,
"result": true,
"error": null
}
Error Codes
This method may return the following error codes in addition to the standard error codes:
| Code | Error | Description |
|---|---|---|
303 |
Unable to Load List | list_id is not a valid List |
315 |
Field Not Found | field_id is not a valid Field in the List |
306 |
Unable to Load Folder | folder_id is not a valid Folder |
313 |
Cannot Edit Account Lists | list_id is an Account List |
368 |
Folder is not a file folder | folder_id is not a File Folder |