Update Project

PATCH https://api.podengine.ai/api/v1/projects/:projectSlug

Update an existing project's details

Example request

curl -X PATCH "https://api.podengine.ai/api/v1/projects/:projectSlug" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_TOKEN" \
  -d '{
  "projectPurpose": "Find podcast guest opportunities for our team"
}'

const options = {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
  "projectPurpose": "Find podcast guest opportunities for our team"
})
};

fetch("https://api.podengine.ai/api/v1/projects/:projectSlug", options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

import requests

headers = {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.patch("https://api.podengine.ai/api/v1/projects/:projectSlug", headers=headers, json={
  "projectPurpose": "Find podcast guest opportunities for our team"
})
print(response.json())

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "YOUR_API_TOKEN");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var json = @"{
  ""projectPurpose"": ""Find podcast guest opportunities for our team""
}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.SendAsync("https://api.podengine.ai/api/v1/projects/:projectSlug");
var data = await response.Content.ReadAsStringAsync();
Console.WriteLine(data);

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	jsonData := []byte(`{
  "projectPurpose": "Find podcast guest opportunities for our team"
}`)
	body := bytes.NewBuffer(jsonData)
	req, _ := http.NewRequest("PATCH", "https://api.podengine.ai/api/v1/projects/:projectSlug", body)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "YOUR_API_TOKEN")
	
	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

import { PodEngine } from '@podengine/sdk';

const pe = new PodEngine({ apiKey: process.env.PODENGINE_API_KEY });

const data = await pe.projects.updateProject({
  projectSlug: 'example-project',
  projectPurpose: 'Find podcast guest opportunities for our team',
});

console.log(data);

import os

from podengine import PodEngine

pe = PodEngine(api_key=os.environ["PODENGINE_API_KEY"])

data = pe.projects.update_project(
    project_slug="example-project",
    project_purpose="Find podcast guest opportunities for our team",
)

print(data)

200

Example response

{
  "status": "string",
  "data": {
    "project": {
      "projectId": "string",
      "name": "string",
      "slug": "string",
      "teamId": "string",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "lastUpdated": "2026-01-15T09:30:00.000Z",
      "createdBy": {
        "id": "string",
        "displayName": "string",
        "avatarSeed": "string"
      },
      "projectTypes": [
        "advertisers"
      ],
      "status": "DRAFT",
      "listedPodcastsCount": 0,
      "linkedGuestProfile": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "status": "ACTIVE",
        "imageUrl": "string",
        "linkedinUrl": "string",
        "companyName": "string",
        "appearancesCount": 0
      },
      "stateCounts": {
        "prospect": 0,
        "qualified": 0,
        "pitched": 0,
        "booked": 0,
        "lost": 0,
        "ignored": 0
      },
      "documentsCount": {
        "total": 0,
        "processed": 0
      },
      "recentActivities": [
        {
          "type": "added-to-list",
          "date": "2026-01-15T09:30:00.000Z",
          "podcastTitle": "string",
          "podcastSlug": "string",
          "podcastImageUrl": "string",
          "toValue": "string",
          "user": {
            "id": "string",
            "displayName": "string",
            "avatarSeed": "string"
          }
        }
      ]
    }
  }
}

Request

Path parameters

projectSlugstringrequired

URL slug identifying the project.

Request body

stateenum

New project lifecycle state.

DRAFTPENDINGACTIVEARCHIVEDERROR

projectPurposestringnullable

Purpose and goals of the project; null clears the stored purpose.

projectKeywordsarray of string

Replacement keywords for the project; an empty array clears them.

Response

200 application/json

statusstringrequired

dataobjectrequired1 field

projectobjectrequired14 fields

projectIdstringrequired

namestringrequired

slugstringrequired

teamIdstringrequired

createdAtdaterequired

lastUpdateddaterequired

createdByobjectrequirednullable3 fields

idstringrequired

displayNamestringrequirednullable

avatarSeedstringrequirednullable

projectTypesarray of enumrequired

advertisersapicontent-creationguest-bookinginteresting-podcastslead-generationmonitoringothertranscriptions

statusenumrequired

DRAFTPENDINGACTIVEARCHIVEDERROR

listedPodcastsCountnumberrequired

linkedGuestProfileobjectrequirednullable8 fields

idstringrequired

namestringrequired

slugstringrequired

statusenumrequired

ACTIVEDRAFTPENDINGARCHIVEDERROR

imageUrlstringrequirednullable

linkedinUrlstringrequirednullable

companyNamestringrequirednullable

appearancesCountnumberrequired

stateCountsobjectrequired6 fields

prospectnumberrequired

qualifiednumberrequired

pitchednumberrequired

bookednumberrequired

lostnumberrequired

ignorednumberrequired

documentsCountobjectrequired2 fields

totalnumberrequired

processednumberrequired

recentActivitiesarray of objectrequired7 fields

typeenumrequired

added-to-listupdate-labelsupdate-priorityupdate-state

datedaterequired

podcastTitlestringrequirednullable

podcastSlugstringrequirednullable

podcastImageUrlstringrequirednullable

toValuestringrequirednullable

userobjectrequirednullable3 fields

idstringrequired

displayNamestringrequirednullable

avatarSeedstringrequirednullable