Push a view onto the stack of a root view.


Method URL:
Preferred HTTP method:POST
Accepted content types:application/x-www-form-urlencoded, application/json
Rate limiting:Tier 4
Works with:
Token typeRequired scope(s)
botNo scope required
userNo scope required
classic botbot

Push a new view onto the existing view stack by passing a view payload and a valid trigger_id generated from an interaction within the existing modal. The pushed view is added to the top of the stack, so the user will go back to the previous view after they complete or cancel the pushed view.

After a modal is opened, the app is limited to pushing 2 additional views.

Read the modals documentation to learn more about the lifecycle and intricacies of views.


Argument Example Required Description

Authentication token bearing required scopes.


Exchange a trigger to post to the user.

view Required

A view payload. This must be a JSON-encoded string.

This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.


If you pass a valid view payload along with a valid trigger_id, you'll receive a success response with the view payload that was pushed to the stack.

Typical success response includes the pushed view payload.

    "ok": true,
    "view": {
        "id": "VNM522E2U",
        "team_id": "T9M4RL1JM",
        "type": "modal",
        "title": {
            "type": "plain_text",
            "text": "Pushed Modal",
            "emoji": true
        "close": {
            "type": "plain_text",
            "text": "Back",
            "emoji": true
        "submit": {
            "type": "plain_text",
            "text": "Save",
            "emoji": true
        "blocks": [
                "type": "input",
                "block_id": "edit_details",
                "element": {
                    "type": "plain_text_input",
                    "action_id": "detail_input",
                    "label": {
                        "type": "plain_text",
                        "text": "Edit details"
        "private_metadata": "",
        "callback_id": "view_4",
        "external_id": "",
        "state": {
            "values": []
        "hash": "1569362015.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": "invalid_arguments",
    "response_metadata": {
        "messages": [
            "missing required field: title"


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 returned when the max push limit has been reached for views. Currently the limit is 3.


Error returned when the given external_id has already be used.


Error returned if the provided view is greater than 250kb.


No authentication token provided.


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.


Authentication token is for a deleted user or workspace.


Authentication token is for a deleted user or workspace or the app has been removed.


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.


The workspace is undergoing an enterprise migration and will not be available until migration is complete.


Administrators have suspended the ability to post a message.


The token used is not granted the specific scope permissions required to complete this request.


The method was called with invalid arguments.


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.


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.


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.


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.


The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.


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.


The method was called via a POST request, but the POST data was either missing or truncated.


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.


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.


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.


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.