PATCH
/api/v1/projects/<PROJECT_ID>

Updates an existing project. Only the provided fields are changed; omitted fields remain the same. Some fields (id, user_id, created) cannot be modified.


Authentication

Request

  • Method: PATCH
  • URL: /api/v1/projects/<PROJECT_ID>

Parameters

name string
Project name. Default: "Untitled Project".
thumb string
Thumbnail URL.
artboards Artboard []
Project artboards.
popups Popup []
Project popups.
data_sources DataSource []
Project data sources.
variables Variable []
Project variables.
actions Action []
Project actions.
settings ProjectSettings
Project settings.

Response

  • 200 OK: The updated Project object.
  • 400 Bad Request: Validation failed. Returns a formatted error message.
  • 401 Unauthorized: API key is missing or invalid.
  • 404 Not Found: Project not found or does not belong to the user.
  • 500 Internal Server Error: Failed to update Project.

Example Request

Example Response