{"_id":"56b0e8cabf040b0d00588a96","user":"5582e90181672a3900bb4fc7","project":"569f9cf6650e1d1900f96b5b","version":{"_id":"569f9cf6650e1d1900f96b5e","project":"569f9cf6650e1d1900f96b5b","__v":12,"createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","56abdd81d4432d1900eed235","56abe0558beeff0d003b8118","56ad2f8b1c09150d00a183a8","56ad4e1cd21f1b0d00fd2f97","56b00ad88f7a4f0d0029dc92","56b2432e9621f20d00efb2bd","56b25826147e900d00d6497a","56b7af2a4b372d2100722c48","56b8c4d938b1070d0028920f","56b8cdab14feef0d0082415d","58599813cf9e112d0032cdab"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","__v":8,"category":{"_id":"56b00ad88f7a4f0d0029dc92","version":"569f9cf6650e1d1900f96b5e","project":"569f9cf6650e1d1900f96b5b","__v":10,"pages":["56b00b4d3c70b01700facf68","56b00b9d3c70b01700facf6a","56b016f43a5b810d00745dca","56b0e8cabf040b0d00588a96","56b0ef73135ec20d00baf9b8","56b21ce83b6f690d00bdb6b6","56b21ea99621f20d00efb273","56b22157a5a1020d00cf4c60","56b224b29621f20d00efb287","56b226677ae4550d00062954"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-02T01:48:08.558Z","from_sync":false,"order":5,"slug":"domain-methods","title":"Domain methods"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-02T17:35:06.947Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"## Syntax \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    <credentials object>, \\n    \\\"domain\\\": <domain_name>\\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request fields for delete_domain\"\n}\n[/block]\nThe following fields can be used in the **delete_domain** method:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Definition/Value\",\n    \"0-0\": \"domain\",\n    \"0-1\": \"Required\",\n    \"0-2\": \"The name of the domain that you want to delete.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response fields for delete_domain\"\n}\n[/block]\nThe following fields may be returned in response to the **delete_domain** method:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Description/Value\",\n    \"0-0\": \"error\",\n    \"0-1\": \"Returned if **success = false**\",\n    \"0-2\": \"A text string that explains the error.\",\n    \"1-0\": \"error_number\",\n    \"1-1\": \"Returned if **success = false**\",\n    \"1-2\": \"A number that represents the error.\",\n    \"2-0\": \"success\",\n    \"2-1\": \"Always returned\",\n    \"2-2\": \"Indicates whether the request was successful or not. Allowed values are **true** and **false**.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples for delete_domain\"\n}\n[/block]\n**Request** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"credentials\\\":{\\n\\t\\t\\t\\\"user\\\": \\\"company_admin:::at:::example.adm\\\",\\n      \\\"password\\\": \\\"seekrit\\\"\\n    }\\n    \\\"domain\\\": \\\"example2.com\\\",\\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n**Response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n   \\\"success\\\": true\\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]","excerpt":"The **delete_domain** method deletes a domain. The domain must not have any users in it.","slug":"delete_domain","type":"basic","title":"delete_domain"}

delete_domain

The **delete_domain** method deletes a domain. The domain must not have any users in it.

## Syntax [block:code] { "codes": [ { "code": "{\n <credentials object>, \n \"domain\": <domain_name>\n}", "language": "perl", "name": " " } ] } [/block] [block:api-header] { "type": "basic", "title": "Request fields for delete_domain" } [/block] The following fields can be used in the **delete_domain** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Definition/Value", "0-0": "domain", "0-1": "Required", "0-2": "The name of the domain that you want to delete." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Response fields for delete_domain" } [/block] The following fields may be returned in response to the **delete_domain** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Description/Value", "0-0": "error", "0-1": "Returned if **success = false**", "0-2": "A text string that explains the error.", "1-0": "error_number", "1-1": "Returned if **success = false**", "1-2": "A number that represents the error.", "2-0": "success", "2-1": "Always returned", "2-2": "Indicates whether the request was successful or not. Allowed values are **true** and **false**." }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Examples for delete_domain" } [/block] **Request** [block:code] { "codes": [ { "code": "{\n \"credentials\":{\n\t\t\t\"user\": \"company_admin@example.adm\",\n \"password\": \"seekrit\"\n }\n \"domain\": \"example2.com\",\n}", "language": "perl", "name": " " } ] } [/block] **Response** [block:code] { "codes": [ { "code": "{\n \"success\": true\n}", "language": "perl", "name": " " } ] } [/block]