views.update.json

{
  "group": "views",
  "name": "views.update",
  "deprecated": false,
  "desc": "Update an existing view.",
  "args": {
    "view": {
      "required": true,
      "desc": "A view object. This must be a JSON-encoded string.",
      "type": "view as string",
      "format": "json"
    },
    "external_id": {
      "required": false,
      "example": "bmarley_view2",
      "desc": "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.",
      "type": "string"
    },
    "view_id": {
      "required": false,
      "example": "VMM512F2U",
      "desc": "A unique identifier of the view to be updated. Either view_id or external_id is required.",
      "type": "string"
    },
    "hash": {
      "required": false,
      "example": "156772938.1827394",
      "desc": "A string that represents view state to protect against possible race conditions.",
      "type": "string"
    }
  },
  "arg_groups": [
    {
      "args": [
        "external_id",
        "view_id"
      ],
      "desc": "Exactly one of these arguments is required to identify the view that is to be updated.",
      "mutually_exclusive": true
    }
  ],
  "response": {
    "examples": [
      "{\n    \"ok\": true,\n    \"view\": {\n        \"id\": \"VNM522E2U\",\n        \"team_id\": \"T9M4RL1JM\",\n        \"type\": \"modal\",\n        \"title\": {\n            \"type\": \"plain_text\",\n            \"text\": \"Updated Modal\",\n            \"emoji\": true\n        },\n        \"close\": {\n            \"type\": \"plain_text\",\n            \"text\": \"Close\",\n            \"emoji\": true\n        },\n        \"submit\": null,\n        \"blocks\": [\n            {\n                \"type\": \"section\",\n                \"block_id\": \"s_block\",\n                \"text\": {\n                    \"type\": \"plain_text\",\n                    \"text\": \"I am but an updated modal\",\n                    \"emoji\": true\n                },\n                \"accessory\": {\n                    \"type\": \"button\",\n                    \"action_id\": \"button_4\",\n                    \"text\": {\n                        \"type\": \"plain_text\",\n                        \"text\": \"Click me\"\n                    }\n                }\n            }\n        ],\n        \"private_metadata\": \"\",\n        \"callback_id\": \"view_2\",\n        \"external_id\": \"\",\n        \"state\": {\n            \"values\": {}\n        },\n        \"hash\": \"1569262015.55b5e41b\",\n        \"clear_on_close\": true,\n        \"notify_on_close\": false,\n        \"root_view_id\": \"VNN729E3U\",\n        \"previous_view_id\": null,\n        \"app_id\": \"AAD3351BQ\",\n        \"bot_id\": \"BADF7A34H\"\n    }\n}",
      "{\n    \"ok\": false,\n    \"error\": \"not_found\"\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.",
    "not_found": "Error returned when the given view_id or external_id doesn't exist.",
    "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_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 user token.",
    "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 _. 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."
  }
}