{"_id":"57624356653c2d2200fec7ce","githubsync":"","parentDoc":null,"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"},"__v":2,"category":{"_id":"57624356653c2d2200fec7a3","project":"55c8cff571d7580d0063a5e5","__v":0,"version":"57624356653c2d2200fec79c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-03-29T04:57:11.108Z","from_sync":false,"order":15,"slug":"account-extension-contact-groups","title":"Account Extension Contact Groups"},"user":"55c8cf9471d7580d0063a5e4","project":"55c8cff571d7580d0063a5e5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-29T20:06:11.614Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"The entries in an extension's address book can be divided into any number of groups. This page gives an overview.\n\n## Supported Services\n* [List Groups](doc:list-account-extension-contact-groups) \n* [Create Group](doc:create-account-extension-contact-group) \n* [Get Group](doc:get-account-extension-contact-group) \n* [Replace Group](doc:replace-account-extension-contact-group) \n* [Delete Group](doc:delete-account-extension-contact-group) \n\n## Summary Object\nThe Group Summary Object is used to briefly represent a contact group. 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\": \"Description\",\n    \"h-2\": \"\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer ID. Read-only.\",\n    \"0-2\": \"\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"Name\",\n    \"1-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 982357,\\n    \\\"name\\\": \\\"NCC 1701-D Bridge Crew\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full Group Object is identical to the [Group Summary Object](#section-summary-object). See above for details.\n\n## Lookup Object\nThe Group Lookup Object is used to link to a group from another object. This is used, for example, when defining filters for [routes](doc:account-routes).  Only *one* of the following properties need to be included. If multiple are specified, then *all* properties must match one of your contacts.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"ID\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"Name\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nHere are some examples:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"contact_group: {\\n    \\\"id\\\": 982357\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"contact_group: {\\n    \\\"name\\\": \\\"NCC 1701-D Bridge Crew\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nInstead of inputting an object, you can also use a scalar value.  A group will be found if the input matches any one of the above fields.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"contact_group: \\\"NCC 1701-D Bridge Crew\\\"\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"account-extension-contact-groups","type":"basic","title":"Groups"}
The entries in an extension's address book can be divided into any number of groups. This page gives an overview. ## Supported Services * [List Groups](doc:list-account-extension-contact-groups) * [Create Group](doc:create-account-extension-contact-group) * [Get Group](doc:get-account-extension-contact-group) * [Replace Group](doc:replace-account-extension-contact-group) * [Delete Group](doc:delete-account-extension-contact-group) ## Summary Object The Group Summary Object is used to briefly represent a contact group. It can occur in several places throughout this API. Here are the properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "h-2": "", "0-0": "`id`", "0-1": "Integer ID. Read-only.", "0-2": "", "1-0": "`name`", "1-1": "Name", "1-2": "" }, "cols": 2, "rows": 2 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": 982357,\n \"name\": \"NCC 1701-D Bridge Crew\"\n}", "language": "json" } ] } [/block] ## Full Object The Full Group Object is identical to the [Group Summary Object](#section-summary-object). See above for details. ## Lookup Object The Group Lookup Object is used to link to a group from another object. This is used, for example, when defining filters for [routes](doc:account-routes). Only *one* of the following properties need to be included. If multiple are specified, then *all* properties must match one of your contacts. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`id`", "0-1": "ID", "1-0": "`name`", "1-1": "Name" }, "cols": 2, "rows": 2 } [/block] Here are some examples: [block:code] { "codes": [ { "code": "contact_group: {\n \"id\": 982357\n}", "language": "json" } ] } [/block] [block:code] { "codes": [ { "code": "contact_group: {\n \"name\": \"NCC 1701-D Bridge Crew\"\n}", "language": "json" } ] } [/block] Instead of inputting an object, you can also use a scalar value. A group will be found if the input matches any one of the above fields. [block:code] { "codes": [ { "code": "contact_group: \"NCC 1701-D Bridge Crew\"", "language": "json" } ] } [/block]