Sign in
latestOpenAPI 3.0.02026-08-1610635191.3 KB

355890b6b4cc

Projects

Update a project

Updates an existing project's name and description. Only the project owner can update their projects.

If a URL is provided without a description, the API will:

  1. Fetch the website content
  2. Use AI to generate a comprehensive project description in markdown format

Either description or url must be provided.

post/projects/{id}/update

Path parameters

idstring required

Project ID (GUID)

Request body

namestring required

Updated name of the project (max 200 characters)

descriptionstring

Updated description of the project. Either description or url must be provided.

urlstring

Optional URL to fetch website content for auto-generating description. If provided without a description, AI will generate one.

imageDatastring nullable

Optional base64 encoded PNG/JPG. Provide null to remove the current brand image. The source image must be fully opaque; images containing any fully or partially transparent pixels are rejected. Any size is accepted and will be resized to 200x50 on upload.

imageUrlstring uri nullable

Optional HTTP/HTTPS URL pointing to a PNG or JPG brand image. Provide null to remove the stored image. The source image must be fully opaque; images containing any fully or partially transparent pixels are rejected. The API stores a 200x50 version. Cannot be combined with imageData.

textColorstring nullable

Optional hex color (format

backgroundColorstring nullable

Optional hex color (format

brandColorstring nullable

Optional primary accent hex color (format

accentColorstring nullable

Optional secondary accent hex color (format

Example request

{
  "name": "AI SaaS Platform",
  "description": "Revolutionary AI-powered content creation platform with advanced automation features.",
  "url": "https://example.com",
  "textColor": "#111827",
  "backgroundColor": "#F9FAFB",
  "brandColor": "#4338CA",
  "accentColor": "#7C72EF"
}

Response

Project updated successfully

successboolean

Example response

{
  "success": true,
  "project": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "AI Startup Launch",
    "description": "Building an AI-powered SaaS tool for content creators. Focus on automation, efficiency, and user experience.",
    "url": "https://example.com",
    "token": "abc123-def456-ghi789",
    "createdOn": "2024-01-01T12:00:00Z",
    "updatedOn": "2024-01-02T14:30:00Z",
    "active": true,
    "textColor": "#111827",
    "backgroundColor": "#F9FAFB",
    "brandColor": "#4338CA",
    "accentColor": "#7C72EF"
  }
}