Skip to main content

lib/slack/web/docs/views.update.json

{
  "desc": "Update an existing view.",

  "args": {
    "view": {
      "required": true,
      "example": "Ar12345",
      "desc": "A view payload. This must be a JSON-encoded string."
    },
    "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."
    },
    "hash": {
      "required": false,
      "example": "156772938.1827394",
      "desc": "A string that represents view state to protect against possible race conditions."
    },
    "view_id": {
      "required": false,
      "example": "VMM512F2U",
      "desc": "A unique identifier of the view to be updated. Either `view_id` or `external_id` is required."
    }
  },

  "response": {
    "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"
    }
  },

  "errors": {
    "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.",
    "duplicate_external_id": "Error returned when the given `external_id` has already be used.",
    "view_too_large" : "Error returned if the provided view is greater than 250kb.",
    "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.",
    "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.",
    "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.",
    "invalid_arguments": "The method was called with invalid arguments.",
    "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_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.",
    "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.",
    "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."
  },

  "warnings": {
    "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.",
    "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous."
  }
}