blob: 34df3d7b7b8a8f288819feba8bf141d0ae36982c [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="people_v1.html">People API</a> . <a href="people_v1.contactGroups.html">contactGroups</a> . <a href="people_v1.contactGroups.members.html">members</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#modify">modify(resourceName, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Modify the members of a contact group owned by the authenticated user.</p>
80<h3>Method Details</h3>
81<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070082 <code class="details" id="modify">modify(resourceName, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083 <pre>Modify the members of a contact group owned by the authenticated user.
Dan O'Mearadd494642020-05-01 07:42:23 -070084
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085The only system contact groups that can have members added are
86`contactGroups/myContacts` and `contactGroups/starred`. Other system
87contact groups are deprecated and can only have contacts removed.
88
89Args:
Dan O'Mearadd494642020-05-01 07:42:23 -070090 resourceName: string, Required. The resource name of the contact group to modify. (required)
91 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092 The object takes the form of:
93
94{ # A request to modify an existing contact group's members. Contacts can be
95 # removed from any group but they can only be added to a user group or
96 # "myContacts" or "starred" system groups.
Dan O'Mearadd494642020-05-01 07:42:23 -070097 "resourceNamesToRemove": [ # Optional. The resource names of the contact people to remove in the form of
98 # `people/{person_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070099 "A String",
100 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700101 "resourceNamesToAdd": [ # Optional. The resource names of the contact people to add in the form of
102 # `people/{person_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103 "A String",
104 ],
105 }
106
107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
111
112Returns:
113 An object of the form:
114
115 { # The response to a modify contact group members request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700116 "canNotRemoveLastContactGroupResourceNames": [ # The contact people resource names that cannot be removed from their
117 # last contact group.
118 "A String",
119 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 "notFoundResourceNames": [ # The contact people resource names that were not found.
121 "A String",
122 ],
123 }</pre>
124</div>
125
126</body></html>