Update a project

PATCH

/api/v1/projects/{project_id}

Partially update a project's name, settings, or store connection. Only provided fields are modified.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"settings": {

  

  

"additionalProperties": "string"

  

},

  

"store_connection_id": "string",

  

"content_profile_id": "string",

  

"settings_overrides": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Successful Response

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"platform": "string",

  

"status": "string",

  

"settings": {

  

  

"additionalProperties": "string"

  

},

  

"created_at": "string",

  

"completed_at": "string",

  

"item_count": 0,

  

"flagged_count": 0,

  

"source_count": 0,

  

"deleted_at": "string",

  

"status_counts": {

  

  

"pending": 0,

  

  

"generated": 0,

  

  

"flagged": 0,

  

  

"approved": 0,

  

  

"rejected": 0,

  

  

"synced": 0,

  

  

"excluded": 0

  

},

  

"store_connection_id": "string",

  

"store_connection_name": "string",

  

"content_profile_id": "string",

  

"settings_overrides": {

  

  

"additionalProperties": "string"

  

}

}

PATCH

/api/v1/projects/{project_id}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples

Powered by VitePress OpenAPI