forked from slack-ruby/slack-api-ref
-
Notifications
You must be signed in to change notification settings - Fork 2
/
usergroups.update.json
84 lines (84 loc) · 6.56 KB
/
usergroups.update.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
{
"group": "usergroups",
"name": "usergroups.update",
"deprecated": false,
"desc": "Update an existing User Group",
"args": {
"usergroup": {
"required": true,
"desc": "The encoded ID of the User Group to update."
},
"channels": {
"required": false,
"desc": "A comma separated string of encoded channel IDs for which the User Group uses as a default.",
"type": "array"
},
"description": {
"required": false,
"desc": "A short description of the User Group.",
"type": "string"
},
"handle": {
"required": false,
"desc": "A mention handle. Must be unique among channels, users and User Groups.",
"type": "string"
},
"include_count": {
"required": false,
"desc": "Include the number of users in the User Group.",
"type": "boolean"
},
"name": {
"required": false,
"desc": "A name for the User Group. Must be unique among User Groups.",
"type": "string"
},
"team_id": {
"required": false,
"desc": "encoded team id where the user group exists, required if org token is used."
}
},
"response": {
"examples": [
"{\n \"ok\": true,\n \"usergroup\": {\n \"id\": \"S0616NG6M\",\n \"team_id\": \"T060R4BHN\",\n \"is_usergroup\": true,\n \"name\": \"Marketing Team\",\n \"description\": \"Marketing gurus, PR experts and product advocates.\",\n \"handle\": \"marketing-team\",\n \"is_external\": false,\n \"date_create\": 1447096577,\n \"date_update\": 1447102109,\n \"date_delete\": 0,\n \"auto_type\": null,\n \"created_by\": \"U060R4BJ4\",\n \"updated_by\": \"U060R4BJ4\",\n \"deleted_by\": null,\n \"prefs\": {\n \"channels\": [],\n \"groups\": []\n },\n \"users\": [\n \"U060R4BJ4\",\n \"U060RNRCZ\"\n ],\n \"user_count\": 1\n }\n}",
"{\n \"ok\": false,\n \"error\": \"invalid_auth\"\n}"
]
},
"errors": {
"permission_denied": "The user does not have permission to update the User Group.",
"paid_teams_only": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.",
"too_many_linked_channels": "This request exceeds the number of channels we supporting linking to a single usergroup.",
"missing_argument": "A required argument is missing.",
"not_authed": "No authentication token provided.",
"invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.",
"account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.",
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.",
"token_expired": "Authentication token has expired.",
"no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"method_deprecated": "The method has been deprecated.",
"deprecated_endpoint": "The endpoint has been deprecated.",
"two_factor_setup_required": "Two factor setup is required.",
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
"is_bot": "This method cannot be called by a bot user.",
"user_is_restricted": "This method cannot be called by a restricted user or single channel guest.",
"team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.",
"invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.",
"invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.",
"invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.",
"missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.",
"team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.",
"ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.",
"accesslimited": "Access to this method is limited on the current network.",
"request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.",
"service_unavailable": "The service is temporarily unavailable.",
"fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.",
"internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised."
}
}