Skip to main content
POST
/
v1
/
project
/
update
/
{projectId}
curl -X POST https://api.mintlify.com/v1/project/update/your_project_id \
  -H "Authorization: Bearer mint_your_api_key_here"

{
  "statusId": "6501a2b3c4d5e6f7g8h9i0j1"
}
Queue a deployment update for your documentation project. Returns a status ID that can be used to track the update progress. The update is triggered from your configured deployment branch.

​
Authentication

Requires an admin API key (prefixed with mint_). Generate one on the API keys page in your dashboard.

​
Path Parameters

​
projectId
string
required
Your project ID. Can be copied from the API keys page in your dashboard.

​
Response

​
statusId
string
The status ID of the triggered update. Use this with the Get update status endpoint to track progress.
curl -X POST https://api.mintlify.com/v1/project/update/your_project_id \
  -H "Authorization: Bearer mint_your_api_key_here"

{
  "statusId": "6501a2b3c4d5e6f7g8h9i0j1"
}

​
Common use cases

  • CI/CD integration: Trigger documentation updates automatically when code changes are pushed to your repository
  • Scheduled updates: Set up cron jobs to refresh documentation at regular intervals
  • Webhook integration: Update docs in response to external events or API calls
  • Multi-environment deployments: Programmatically manage deployments across different environments

Build docs developers (and LLMs) love

Get started for freeTalk to us