{"_id":"57dc5b78de08c819002a165c","user":"56f99ab84d2b4f3400edb636","__v":0,"project":"55c8cff571d7580d0063a5e5","version":{"_id":"57624356653c2d2200fec79c","__v":21,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"category":{"_id":"57624356653c2d2200fec79e","__v":0,"project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-10T18:41:19.944Z","from_sync":false,"order":4,"slug":"text-messaging","title":"Accounts"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-16T20:52:08.489Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"This page gives an overview of how to interact with your accounts.\n\n## Supported Services\n* [List Accounts](doc:list-accounts)\n* [Get Account](doc:get-account)\n\n## Summary Object\nThe Account Summary Object is used to briefly represent an account. It can occur in several places throughout this API. Here are the properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Account ID.  Sometimes referred to as \\\"Voip ID\\\" or \\\"voip_id\\\".\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Name on the account. Read-only.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 7069275,\\n    \\\"name\\\": \\\"Acme, Inc.\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full Account Object includes all of the properties in the [Account Summary Object](#section-summary-object), along with the following:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"'username'\",\n    \"1-0\": \"'password'\",\n    \"0-1\": \"Account user name\",\n    \"1-1\": \"Account password.  For security reason, this is masked as \\\"********\\\"\",\n    \"2-0\": \"`master_account`\",\n    \"2-1\": \"If this account is a subaccount, this property shows the master account that it belongs to.  Otherwise it is `NULL`.  Read-only.  Output is an [Account Summary Object](doc:accounts#section-summary-object).\",\n    \"4-0\": \"`billing_contact`\",\n    \"4-1\": \"[Contact Object](#section-contact-object) for billing purposes. See below for details.\",\n    \"3-0\": \"`contact`\",\n    \"3-1\": \"[Contact Object](#section-contact-object). See below for details.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 123,\\n    \\\"name\\\": \\\"John Taylpr\\\",\\n    \\\"username\\\" : \\\"IAmLegend\\\",\\n    \\\"password\\\" : \\\"********\\\",\\n    \\\"master_account\\\": {\\n        \\\"id\\\": 6212,\\n        \\\"name\\\": \\\"Bobby Smith\\\",\\n    },\\n    \\\"contact\\\": {\\n        \\\"name\\\": \\\"Teddy\\\",\\n        \\\"company\\\": \\\"Acme, Inc.\\\",\\n        \\\"address\\\": {\\n            \\\"line_1\\\": \\\"14282 Danielson Street\\\",\\n            \\\"line_2\\\": \\\"box 2\\\",\\n            \\\"city\\\": \\\"Poway\\\",\\n            \\\"province\\\": \\\"CA\\\",\\n            \\\"postal_code\\\": \\\"92064\\\",\\n            \\\"country\\\": \\\"US\\\"\\n        },\\n        \\\"phone\\\": \\\"+18585551111\\\",\\n        \\\"fax\\\": \\\"+18585552222\\\",\\n        \\\"primary_email\\\": \\\"test:::at:::phone.com\\\",\\n        \\\"alternate_email\\\": \\\"test@gmail.com\\\"\\n    },\\n    \\\"billing_contact\\\": {\\n        \\\"name\\\": \\\"Bobby\\\",\\n        \\\"company\\\": \\\"xyz co\\\",\\n        \\\"address\\\": {\\n            \\\"line_1\\\": \\\"100 Main St\\\",\\n            \\\"line_2\\\": \\\"#4\\\",\\n            \\\"city\\\": \\\"San Diego\\\",\\n            \\\"province\\\": \\\"CA\\\",\\n            \\\"postal_code\\\": \\\"92129\\\",\\n            \\\"country\\\": \\\"US\\\"\\n        },\\n        \\\"phone\\\": \\\"+18585553333\\\",\\n        \\\"fax\\\": \\\"+18585554444\\\",\\n        \\\"primary_email\\\": \\\"sample@phone.com\\\",\\n        \\\"alternate_email\\\": \\\"sample@gmail.com\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Contact Object\nThe Contact object displays the subaccount's contact information.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`name`\",\n    \"1-0\": \"`company`\",\n    \"2-0\": \"`address`\",\n    \"3-0\": \"`phone`\",\n    \"4-0\": \"`fax`\",\n    \"5-0\": \"`primary_email`\",\n    \"6-0\": \"`alternate_email`\",\n    \"0-1\": \"Name. Required.\",\n    \"1-1\": \"Company name\",\n    \"2-1\": \"[Contact Address Object](#section-contact-address-object). See below for details.\",\n    \"3-1\": \"Phone number. Required.\",\n    \"4-1\": \"Fax number\",\n    \"5-1\": \"Primary email address. Required.\",\n    \"6-1\": \"Alternate email address\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n## Contact Address Object\nThe Contact Address object is the contact address information.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`line_1`\",\n    \"1-0\": \"`line_2`\",\n    \"2-0\": \"`city`\",\n    \"3-0\": \"`province`\",\n    \"4-0\": \"`postal_code`\",\n    \"5-0\": \"`country`\",\n    \"0-1\": \"Street address line 1. Required.\",\n    \"1-1\": \"Street address line 2\",\n    \"2-1\": \"City. Required.\",\n    \"3-1\": \"Province. Required if country is US.\",\n    \"4-1\": \"Postal code\",\n    \"5-1\": \"2-character country code. Required.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","excerpt":"","slug":"accounts","type":"basic","title":"Accounts"}
This page gives an overview of how to interact with your accounts. ## Supported Services * [List Accounts](doc:list-accounts) * [Get Account](doc:get-account) ## Summary Object The Account Summary Object is used to briefly represent an account. It can occur in several places throughout this API. Here are the properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "Integer", "0-2": "Account ID. Sometimes referred to as \"Voip ID\" or \"voip_id\".", "1-0": "`name`", "1-1": "String", "1-2": "Name on the account. Read-only." }, "cols": 3, "rows": 2 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": 7069275,\n \"name\": \"Acme, Inc.\"\n}", "language": "json" } ] } [/block] ## Full Object The Full Account Object includes all of the properties in the [Account Summary Object](#section-summary-object), along with the following: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "'username'", "1-0": "'password'", "0-1": "Account user name", "1-1": "Account password. For security reason, this is masked as \"********\"", "2-0": "`master_account`", "2-1": "If this account is a subaccount, this property shows the master account that it belongs to. Otherwise it is `NULL`. Read-only. Output is an [Account Summary Object](doc:accounts#section-summary-object).", "4-0": "`billing_contact`", "4-1": "[Contact Object](#section-contact-object) for billing purposes. See below for details.", "3-0": "`contact`", "3-1": "[Contact Object](#section-contact-object). See below for details." }, "cols": 2, "rows": 5 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": 123,\n \"name\": \"John Taylpr\",\n \"username\" : \"IAmLegend\",\n \"password\" : \"********\",\n \"master_account\": {\n \"id\": 6212,\n \"name\": \"Bobby Smith\",\n },\n \"contact\": {\n \"name\": \"Teddy\",\n \"company\": \"Acme, Inc.\",\n \"address\": {\n \"line_1\": \"14282 Danielson Street\",\n \"line_2\": \"box 2\",\n \"city\": \"Poway\",\n \"province\": \"CA\",\n \"postal_code\": \"92064\",\n \"country\": \"US\"\n },\n \"phone\": \"+18585551111\",\n \"fax\": \"+18585552222\",\n \"primary_email\": \"test@phone.com\",\n \"alternate_email\": \"test@gmail.com\"\n },\n \"billing_contact\": {\n \"name\": \"Bobby\",\n \"company\": \"xyz co\",\n \"address\": {\n \"line_1\": \"100 Main St\",\n \"line_2\": \"#4\",\n \"city\": \"San Diego\",\n \"province\": \"CA\",\n \"postal_code\": \"92129\",\n \"country\": \"US\"\n },\n \"phone\": \"+18585553333\",\n \"fax\": \"+18585554444\",\n \"primary_email\": \"sample@phone.com\",\n \"alternate_email\": \"sample@gmail.com\"\n }\n}", "language": "json" } ] } [/block] ## Contact Object The Contact object displays the subaccount's contact information. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`name`", "1-0": "`company`", "2-0": "`address`", "3-0": "`phone`", "4-0": "`fax`", "5-0": "`primary_email`", "6-0": "`alternate_email`", "0-1": "Name. Required.", "1-1": "Company name", "2-1": "[Contact Address Object](#section-contact-address-object). See below for details.", "3-1": "Phone number. Required.", "4-1": "Fax number", "5-1": "Primary email address. Required.", "6-1": "Alternate email address" }, "cols": 2, "rows": 7 } [/block] ## Contact Address Object The Contact Address object is the contact address information. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`line_1`", "1-0": "`line_2`", "2-0": "`city`", "3-0": "`province`", "4-0": "`postal_code`", "5-0": "`country`", "0-1": "Street address line 1. Required.", "1-1": "Street address line 2", "2-1": "City. Required.", "3-1": "Province. Required if country is US.", "4-1": "Postal code", "5-1": "2-character country code. Required." }, "cols": 2, "rows": 6 } [/block]