---
updatedAt: 2026-06-26T11:20:46.000Z
agentTools:
  projectIndex: https://developers.miro.com/llms.txt
---

# Update board export job status

Updates the status of the board export job.<br/>Currently, only the cancellation of an ongoing export job is supported.<br/><h3>Required scope</h3> <a target="blank" href="/reference/scopes">boards:export</a> <br/><h3>Rate limiting</h3> <a target="blank" href="/reference/rate-limiting#rate-limit-tiers">Level 4</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target="blank" href="/reference/api-reference#enterprise-plan">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using <a target="_blank" href="https://q2oeb0jrhgi.typeform.com/to/BVPTNWJ9">this form</a>.</p>

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "eDiscovery (Enterprise Guard)",
    "version": "v2"
  },
  "x-settings": {
    "publish": true
  },
  "servers": [
    {
      "url": "https://api.miro.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "description": "API to export Miro board data.",
      "name": "Board Export"
    }
  ],
  "paths": {
    "/v2/orgs/{org_id}/boards/export/jobs/{job_id}/status": {
      "put": {
        "x-settings": {
          "skip-tests": true
        },
        "description": "Updates the status of the board export job.<br/>Currently, only the cancellation of an ongoing export job is supported.<br/><h3>Required scope</h3> <a target=\"blank\" href=\"/reference/scopes\">boards:export</a> <br/><h3>Rate limiting</h3> <a target=\"blank\" href=\"/reference/rate-limiting#rate-limit-tiers\">Level 4</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=\"blank\" href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using <a target=\"_blank\" href=\"https://q2oeb0jrhgi.typeform.com/to/BVPTNWJ9\">this form</a>.</p>",
        "operationId": "enterprise-update-board-export-job",
        "parameters": [
          {
            "description": "Unique identifier of the organization.",
            "example": "3074457345821141000",
            "in": "path",
            "name": "org_id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Unique identifier of the board export job.",
            "example": "92343229-c532-446d-b8cb-2f155bedb807",
            "in": "path",
            "name": "job_id",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "status"
                ],
                "properties": {
                  "status": {
                    "description": "Only the `CANCELLED` status is currently supported.",
                    "type": "string",
                    "enum": [
                      "CANCELLED"
                    ]
                  }
                },
                "example": {
                  "status": "CANCELLED"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status"
                  ],
                  "properties": {
                    "status": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/BoardExportJobStatus"
                        },
                        {
                          "type": "string",
                          "example": "CANCELLED"
                        }
                      ]
                    }
                  }
                }
              }
            },
            "description": "Update board export job status"
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "summary": "Update board export job status",
        "tags": [
          "Board Export"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ExportJobStatus": {
        "type": "string",
        "description": "Indicates the current state of the board export job.\nPossible values:\n`CREATED`: the job has been created but not yet started. Retry the status call after some time.\n`IN_PROGRESS`: the job is in progress, and the results are not ready yet. Retry the status call after some time.\n`CANCELLED`: the job has been cancelled and will not produce any more results.\n`FINISHED`: the job is complete. You can now get results for the board export job.",
        "enum": [
          "CREATED",
          "IN_PROGRESS",
          "CANCELLED",
          "FINISHED"
        ],
        "example": "CREATED"
      },
      "BoardExportJobStatus": {
        "required": [
          "jobStatus"
        ],
        "type": "object",
        "properties": {
          "jobStatus": {
            "$ref": "#/components/schemas/ExportJobStatus"
          }
        }
      },
      "BasicError": {
        "type": "object",
        "properties": {
          "status": {
            "type": "number",
            "description": "HTTP status code."
          },
          "code": {
            "type": "string",
            "description": "Description of the status code."
          },
          "message": {
            "type": "string",
            "description": "Explanation for the error"
          },
          "type": {
            "type": "string",
            "description": "Type of the object returned.",
            "default": "error"
          }
        }
      }
    },
    "responses": {
      "400": {
        "description": "Malformed request",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/BasicError"
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "default": 400
                    },
                    "code": {
                      "default": "invalidParameters"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "401": {
        "description": "Invalid authentication credentials",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/BasicError"
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "default": 401
                    },
                    "code": {
                      "default": "tokenNotProvided"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "403": {
        "description": "Invalid access",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/BasicError"
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "default": 403
                    },
                    "code": {
                      "default": "forbiddenAccess"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "Not found",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/BasicError"
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "default": 404
                    },
                    "code": {
                      "default": "notFound"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "429": {
        "description": "Too many requests",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/BasicError"
                },
                {
                  "type": "object",
                  "properties": {
                    "status": {
                      "default": 429
                    },
                    "code": {
                      "default": "tooManyRequests"
                    }
                  }
                }
              ]
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```

# Sibling pages

* [Create board export job](https://developers.miro.com/miro-ea/reference/enterprise-create-board-export.md)
* [Get board export jobs list](https://developers.miro.com/miro-ea/reference/enterprise-board-export-jobs.md)
* [Get board export job status](https://developers.miro.com/miro-ea/reference/enterprise-board-export-job-status.md)
* [Get results for board export job](https://developers.miro.com/miro-ea/reference/enterprise-board-export-job-results.md)
* [Get board export job tasks list](https://developers.miro.com/miro-ea/reference/enterprise-board-export-job-tasks.md)
* [Create task export link](https://developers.miro.com/miro-ea/reference/enterprise-create-board-export-task-export-link.md)