Domains¶
Functions for the domains endpoint. See the Official Documentation for more information.
Search Domains¶
Use this endpoint to search for domains within a Bodis account.
1Bodis::searchDomains();
You can pass any parameters listed in their documentation as an array.
1Bodis::searchDomains([
2 'page' => 1,
3 'per_page' => 25
4 'filters' => [
5 'domains' => [
6 'test.com'
7 ]
8 ]
9]);
Domains returned will be an array of the Domain Resource: Example Response .. code-block:
{
"current_page": 1,
"data": [
0 => JeffreyHosler\BodisApiWrapper\Resources\Domain {
+domainNameId: 0000000
+domainName: "test.com"
+domainNameDisplay: null
+domainNameNoTld: "test"
+domainNameLength: 4
+tldName: ".com"
+userId: 0000
+notes: null
+timeAddedToSystem: "2020-11-18 00:59:51"
+timeAddedToUser: "2020-11-18 00:59:51"
+isIdn: "n"
+googleIsBanned: "n"
+googleBannedReason: null
+isAdult: "n"
+adProvider: "G"
+imprint: "false"
+zeroclickDisabled: "false"
+isZeroclickBanned: 0
+preferredFeed: null
+preferredFeedLastChangedBy: null
+folderId: 0
+folderName: "Test Folder"
+userSuggestKeywords: "Test"
+userSuggestKeywordsConflictStatus: "approved"
+userRsKeywords: "Test, Folder, Test Folder"
+userRsKeywordsConflictStatus: "approved"
}
]
"first_page_url": "https://api.bodis.com/v2/domains/search?page=1",
"from": 1,
"next_page_url": "https://api.bodis.com/v2/domains/search?page=2",
"path": "https://api.bodis.com/v2/domains/search",
"per_page": 2,
"prev_page_url": null,
"to": 2,
"total": 3106,
"last_page": 1553
}
Add Domains¶
Use this endpoint to add new domains to a Bodis account.
1Bodis::addDomains([
2 'domains' => [
3 'test.com',
4 'test2.com'
5 ],
6 'folder' => [
7 'id' => 1,
8 'apply_settings' => false
9 ]
10]);
The response will be a json response from Bodis that shows which domains succeeded and which ones failed
{
"success" => [
"example.com"
],
"fail" => {
"example.invalid": "TLD extension is currently not supported.",
"example.org": "Domain name is already in your account."
},
"conflict" => [
"example.net"
]
}
Update Domains¶
Use this endpoint to update domains within a Bodis account.
1Bodis::updateDomains([
2 'domains' => [
3 'test.com',
4 'test2.com'
5 ],
6 'folder' => [
7 'id' => 1,
8 'apply_settings' => false
9 ],
10 'parking' => [
11 'keywords' => [
12 'master_keywords' => [
13 'Test',
14 'Test2'
15 ],
16 'related_search_terms' => [
17 'Testing',
18 'Tester'
19 ]
20 ]
21 ]
22]);
Note
This endpoint does not return any content
Delete Domains¶
Use this endpoint to delete domains from a Bodis account.
1Bodis::deleteDomains([
2 'domains' => [
3 'test.com',
4 'test2.com'
5 ]
6]);
Note
This endpoint does not return any content