Update an existing view.
POSThttps://slack-gov.com/api/views.update
application/x-www-form-urlencoded
application/json
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
xxxx-xxxxxxxxx-xxxx
view
A view object. This must be a JSON-encoded string.
external_id
view_id
Exactly one of these arguments is required to identify the view that is to be updated.
A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either view_id
or external_id
is required.
bmarley_view2
Update a view by passing a new view definition object along with the view_id
returned in views.open
or the external_id
. See the modals documentation to learn more about updating views and avoiding race conditions with the hash
argument.
input
entryData entered or selected in input
blocks can be preserved while updating views. The new view
object that you use with views.update
should contain the same input blocks and elements with identical block_id
and action_id
values.
If you pass a valid view
object along with a view_id
or external_id
, you'll receive a success response with the updated payload.
Typical success response includes the updated view payload.
{
"ok": true,
"view": {
"id": "VNM522E2U",
"team_id": "T9M4RL1JM",
"type": "modal",
"title": {
"type": "plain_text",
"text": "Updated Modal",
"emoji": true
},
"close": {
"type": "plain_text",
"text": "Close",
"emoji": true
},
"submit": null,
"blocks": [
{
"type": "section",
"block_id": "s_block",
"text": {
"type": "plain_text",
"text": "I am but an updated modal",
"emoji": true
},
"accessory": {
"type": "button",
"action_id": "button_4",
"text": {
"type": "plain_text",
"text": "Click me"
}
}
}
],
"private_metadata": "",
"callback_id": "view_2",
"external_id": "",
"state": {
"values": {}
},
"hash": "1569262015.55b5e41b",
"clear_on_close": true,
"notify_on_close": false,
"root_view_id": "VNN729E3U",
"previous_view_id": null,
"app_id": "AAD3351BQ",
"bot_id": "BADF7A34H"
}
}
Typical error response.
{
"ok": false,
"error": "not_found"
}
This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok
params in the response.
Error | Description |
---|---|
duplicate_external_id | Error returned when the given |
hash_conflict | Error returned when the provided |
not_found | Error returned when the given |
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 |
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_allowed_token_type | The token type used in this request is not allowed. |
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 |
two_factor_setup_required | Two factor setup is required. |
team_access_not_granted | The token used is not granted the specific workspace access required to complete this request. |
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 |
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 |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
ratelimited | The request has been ratelimited. Refer to the |
request_timeout | The method was called via a |
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. |
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |