-
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Slack API Ref Buildbot
committed
Aug 19, 2023
1 parent
6ad3333
commit 5dca440
Showing
1 changed file
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
{ | ||
"group": "views", | ||
"name": "views.publish", | ||
"deprecated": false, | ||
"desc": "Publish a static view for a User.", | ||
"args": { | ||
"user_id": { | ||
"required": true, | ||
"example": "U0BPQUNTA", | ||
"desc": "id of the user you want publish a view to.", | ||
"type": "string" | ||
}, | ||
"view": { | ||
"required": true, | ||
"desc": "A view payload. This must be a JSON-encoded string.", | ||
"type": "view as string", | ||
"format": "json" | ||
}, | ||
"hash": { | ||
"required": false, | ||
"example": "156772938.1827394", | ||
"desc": "A string that represents view state to protect against possible race conditions.", | ||
"type": "string" | ||
} | ||
}, | ||
"response": { | ||
"examples": [ | ||
"{\n \"ok\": true,\n \"view\": {\n \"id\": \"VMHU10V25\",\n \"team_id\": \"T8N4K1JN\",\n \"type\": \"home\",\n \"close\": null,\n \"submit\": null,\n \"blocks\": [\n {\n \"type\": \"section\",\n \"block_id\": \"2WGp9\",\n \"text\": {\n \"type\": \"mrkdwn\",\n \"text\": \"A simple section with some sample sentence.\",\n \"verbatim\": false\n }\n }\n ],\n \"private_metadata\": \"Shh it is a secret\",\n \"callback_id\": \"identify_your_home_tab\",\n \"state\": {\n \"values\": {}\n },\n \"hash\": \"156772938.1827394\",\n \"clear_on_close\": false,\n \"notify_on_close\": false,\n \"root_view_id\": \"VMHU10V25\",\n \"previous_view_id\": null,\n \"app_id\": \"AA4928AQ\",\n \"external_id\": \"\",\n \"bot_id\": \"BA13894H\"\n }\n}", | ||
"{\n \"ok\": false,\n \"error\": \"invalid_arguments\",\n \"response_metadata\": {\n \"messages\": [\n \"invalid `user_id`\"\n ]\n }\n}" | ||
] | ||
}, | ||
"errors": { | ||
"duplicate_external_id": "Error returned when the given external_id has already be used.", | ||
"hash_conflict": "Error returned when the provided hash doesn't match the current stored value.", | ||
"missing_profile_id": "A profile id was not provided when trying to publish a view of type profile.", | ||
"not_allowed_token_type": "The token type used in this request is not allowed.", | ||
"not_enabled": "Error returned if a home view is published but the Home tab isn't enabled for the app.", | ||
"not_implemented": "The profile view experiment is not enabled for this user.", | ||
"view_too_large": "Error returned if the provided view is greater than 250kb.", | ||
"access_denied": "Access to a resource specified in the request is denied.", | ||
"account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", | ||
"deprecated_endpoint": "The endpoint has been deprecated.", | ||
"ekm_access_denied": "Administrators have suspended the ability to post a message.", | ||
"enterprise_is_restricted": "The method cannot be called from an Enterprise.", | ||
"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.", | ||
"method_deprecated": "The method has been deprecated.", | ||
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", | ||
"not_authed": "No authentication token provided.", | ||
"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.", | ||
"token_expired": "Authentication token has expired.", | ||
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", | ||
"two_factor_setup_required": "Two factor setup is required.", | ||
"accesslimited": "Access to this method is limited on the current network.", | ||
"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.", | ||
"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_arguments": "The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.", | ||
"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.", | ||
"ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", | ||
"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.", | ||
"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." | ||
} | ||
} |