Folders

Functions for the folders endpoint. See the Official Documentation for more information.

List Folders

Use this endpoint to obtain a list of folders within a Bodis account.

1Bodis::listFolders();

You can pass any parameters listed in their documentation as an array.

1Bodis::listFolders();
2   'page' => 1,
3   'per_page' => 25
4]);

Folders returned will be an array of the Folder Resource: Example Response

'data' => [
   0 => JeffreyHosler\BodisApiWrapper\Resources\Folder {
      +id: 000
      +totalDomains: 483
      +name: 'Test Folder'
   }
   1 => JeffreyHosler\BodisApiWrapper\Resources\Folder {
      +id: 001
      +totalDomains: 12
      +name: 'Test 2 Folder'
   }
]
'current_page' => 1
'first_page_url' => 'https://api.bodis.com/v2/folders?page=1'
'from' => 1
'last_page' => 1
'last_page_url' => 'https://api.bodis.com/v2/folders?page=3'
'next_page_url' => 'https://api.bodis.com/v2/folders?page=2'
'path' => 'https://api.bodis.com/v2/folders'
'per_page' => 25
'prev_page_url' => null
'to' => 25
'total' => 2

Add Folder

Use this endpoint to add new folders to a Bodis account.

1Bodis::addFolder([
2   'name' => 'New Folder'
3]);

Folders returned will be an array of the Folder Resource: Example Response

JeffreyHosler\BodisApiWrapper\Resources\Folder {
   'name' => 'New Folder',
   'user_id' => 00000,
   'id' => 0003
}

Update Folder

Use this endpoint to update folders within a Bodis account.

 1Bodis::updateFolder($id, [
 2   'apply_settings' => false,
 3   'parking' => [
 4      'imprint' => false,
 5      'zeroclick_disabled' => false,
 6      'keywords' => [
 7         'master_keywords' => [
 8            'Video Games',
 9            'Free Games'
10         ],
11         'related_search_terms' => [
12            'Play Free Games',
13            'Free Games Online'
14         ]
15      ]
16   ],
17   'sale' => [
18      'status' => 'NOT_FOR_SALE',
19      'url' => 'https://example.com/{DOMAIN_NAME}',
20      'price' => 1000,
21      'min_price' => 800,
22      'desktop_location' => 'TOP',
23      'desktop_custom_text' => '{DOMAIN_NAME} is for sale!',
24      'desktop_type' => 'BLEND_IN',
25      'mobile_location' => 'TOP',
26      'mobile_custom_text' => '{DOMAIN_NAME} is for sale and great for mobile!',
27      'mobile_type' => 'HIGHLIGHT',
28      'is_auto_redirect' => false,
29      'custom_inquiry_text' => 'Serious offers only, please.'
30   ]
31]);

Note

This endpoint does not return any content

Delete Folder

Use this endpoint to delete folders from a Bodis account.

1Bodis::deleteFolder($id);

Note

This endpoint does not return any content