{"_id":"55917ba44e50b50d001960e0","githubsync":"","project":"558d9c32beb7c719007f6319","user":"558d70614cd25f0d00b7eba4","version":{"_id":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","__v":19,"createdAt":"2015-06-26T18:38:43.154Z","releaseDate":"2015-06-26T18:38:43.153Z","categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5908d1f64f544425002b6aae","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T18:37:42.174Z","from_sync":false,"order":9,"slug":"legacy-documentation","title":"Legacy Documentation"},"parentDoc":null,"__v":122,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-29T17:08:52.454Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use the Contact Groups API to create and organize group contacts.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0BVKK0xxTQS2lKjg2y97_book_contacts-128.png\",\n        \"book_contacts-128.png\",\n        \"128\",\n        \"128\",\n        \"#7cb43c\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nThe Contact Groups API allows the user the ability to create and organize his or her contacts into groups. It enables the user to create and list groups according to their function, add and remove contacts, and add a list of phone numbers to different services.\n\nThe user may utilize the Contact Groups API with the Create, Details, Empty, List, Member Add, Member Remove, Remove, and Rename methods. \n\n## Create\n    group.create\n\nUse the Create method to create a new group of contacts.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-0\": \"Group Name\",\n    \"1-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n## Details\n    group.details\n\nUse the Details method to list the names, phone numbers, and email addresses for desired contact groups.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"0-0\": \"API Key\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-1\": \"X\",\n    \"1-0\": \"Group ID\",\n    \"1-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n## Empty\n    group.empty\n\nUse the Empty method to clear all the contacts in a specified group.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-0\": \"Group ID\",\n    \"1-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n## List\n    group.list\n\nUse the List method to list all user contact groups.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n## Member Add\n    group.memberadd\n\nUse the Member Add method to add a new contact to a contact group.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-0\": \"Group ID\",\n    \"1-1\": \"X\",\n    \"2-0\": \"Member Email\",\n    \"2-2\": \"X\",\n    \"3-0\": \"Member Name\",\n    \"3-1\": \"X\",\n    \"4-1\": \"X\",\n    \"4-0\": \"Member Phone\",\n    \"5-0\": \"Members\",\n    \"5-2\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n## Member Remove\n    group.memberremove\n\nUse the Member Remove method to delete an entry in a contact group.\n\nThe parameters listed in the following table may be needed to complete this action:\n    \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-0\": \"Member ID\",\n    \"1-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n## Remove\n    group.remove\n\nUse the Remove method to delete an existing contact group.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-1\": \"X\",\n    \"1-0\": \"Group ID\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n## Rename\n    group.rename\n\nUse the Rename method to rename a contact group.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-1\": \"X\",\n    \"1-1\": \"X\",\n    \"2-1\": \"X\",\n    \"0-0\": \"API Key\",\n    \"1-0\": \"Group ID\",\n    \"2-0\": \"Name\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"link\",\n  \"title\": \"API Test Panel\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ebnFeHAwTHqfH9PxVbxK_1437618071_monitor-gear-control-panel.png\",\n        \"1437618071_monitor-gear-control-panel.png\",\n        \"48\",\n        \"48\",\n        \"#fcf1d4\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nUse the DialogTech [API Wizard and Test Panel](https://secure.ifbyphone.com/developer_testpanel.php) to make changes to a customer account.\n\nPlease note that this tool works with the live data in a customer account. The user must be careful when adding, editing, or deleting data.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example URLs\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0SkhNxCWQB2X7NDkOCQu_1440199635_link_add.png\",\n        \"1440199635_link_add.png\",\n        \"32\",\n        \"32\",\n        \"#609e04\",\n        \"\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Create Example URL: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=group.create&group_name=work\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Details Example URL: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=group.details&group_id=81\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Empty Example URL: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=group.empty&group_id=123\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**List Example URL: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=group.list\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Member Add Example URL: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=group.memberadd&group_id=81&member_name=Jane%20Smith&member_phone=8475551234&member_email=jane:::at:::example.com\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Member Remove Example URL: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=group.memberremove&member_id=261\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Remove Example URL: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=group.remove&group_id=82\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Rename Example URL: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=group.rename&group_id=123&name=Example%20Group\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Responses\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/YFl9VpcHR0m7eQkiY1ei_1440199713_XML_Extention.png\",\n        \"1440199713_XML_Extention.png\",\n        \"32\",\n        \"32\",\n        \"#37472b\",\n        \"\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Create Example Response: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Created group successfully</result_description>\\n<group_id>0000</group_id>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Details Example Response: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>success</result_description>\\n<group_details>\\n<member>\\n<member_id>123</member_id>\\n<member_name>John Doe</member_name>\\n<member_phone>8475551234</member_phone>\\n<member_email>john@example.com</member_email>\\n</member>\\n<member>\\n<member_id>456</member_id>\\n<member_name>Jane Smith</member_name>\\n<member_phone>3125554321</member_phone>\\n<member_email>jane@example.com</member_email>\\n</member>\\n</group_details>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Empty Example Response: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Emptied group successfully.</result_description>\\n<group_id>\\n</group_id>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**List Example Response: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>success</result_description>\\n<group_list>\\n<group>\\n<group_id>81</group_id>\\n<group_name>dGroup</group_name>\\n<contact_count>1</contact_count>\\n</group>\\n<group>\\n<group_id>82</group_id>\\n<group_name>api test</group_name>\\n<contact_count>0</contact_count>\\n</group>\\n</group_list>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Member Add Example Response: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Added member to group successfully.</result_description>\\n<member_id>261</member_id>\\n<group_id>81</group_id>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Member Remove Example Response: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Removed member from group successfully.</result_description>\\n<member_id>261</member_id>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Remove Example Response: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Removed group successfully.</result_description>\\n<group_id>82</group_id>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Rename Example Response: **\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Renamed group successfully.</result_description>\\n<group_id>81</group_id>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"contact-groups","type":"basic","title":"CONTACT GROUPS"}