Projects: Products

🔒 Обновление параметров продукта в проекте.

Обновление параметров продукта в проекте.

Access: authorized (10 ) · Scope: write

Allows: product:update (все обязательны; ресурс — <тип>ID / ID из запроса, user:* — userID или сам пользователь)

TypeScript (copy-paste)

POST /projects/product/update

<details open><summary><b>Params</b></summary>
export interface ProjectsProductUpdateParams {
  ID: string
}
</details> <details open><summary><b>Body (Partial)</b></summary>
// Patch-body: все поля опциональны (Valid.Patch)
export type ProjectsProductUpdateBody = Partial<Product>

export interface ProjectsProductUpdateBodyFields {
  cID?: string
  projectID?: string
  ID?: string
  logoFID?: string | null
  cardFID?: string | null
  analyticAssignee?: string
  platform?: Product_Platform
  title?: string
  techStack?: Array<string>
  leadUID?: string
  startD?: string
  isDeleted?: boolean | null
  /** Unix timestamp in milliseconds */
  deletedTS?: number | null
  isArchived?: boolean | null
  /** Unix timestamp in milliseconds */
  archivedTS?: number | null
  isDeployEnabled?: boolean | null
  team?: Record<string, any> | null
  git?: Record<string, any> | null
  design?: {
  fileUrl?: string | null
  uiKitUrl?: string | null
  refUrls?: Array<{
  title?: string | null
  url: string
}> | null
} | null
  /** Unix timestamp in milliseconds */
  ord?: number
  spec?: string
  /** Unix timestamp in milliseconds */
  updTS?: number
  updUID?: string
}
</details> <details open><summary><b>Response</b></summary>
export type ProjectsProductUpdateResponse = IServerResponse<Product>

export interface IServerResponse<T = any> {
  code: number
  data: T
  srvTS: number
  rkey: string
}
</details>

Полный файл типов: /docs/types · raw: /docs/api-types.ts

post/projects/product/update

Request

  • Base URL: http://localhost
  • URL: http://localhost/projects/product/update
  • Auth: one of:
    • API key in header sid and API key in header rts and API key in header sig
    • HTTP bearer

Query parameters

IDstring uuid required

Можно передать header ID (сервер мержит headers+query)

Headers

devIDstring uuid required

UUID устройства клиента

tzstring required
Example:Europe/Moscow

Таймзона клиента (IANA или offset)

appstring required
Example:kosmodrom-web

Имя клиентского приложения

appVerstring required
Example:1.0.0

Версия клиента

rKeystring

Уникальный ключ запроса для логов/саппорта

Request body

cIDstring uuid
projectIDstring uuid
IDstring uuid
logoFIDstring uuid nullable
cardFIDstring uuid nullable
analyticAssigneestring
platform10 | 20 | 30 | 40 | 50 | 60

webApp = 10, backend = 20, website = 30, ios = 40, android = 50, ai = 60

titlestring
techStackstring[]
leadUIDstring uuid
startDstring date-time
isDeletedboolean nullable
deletedTSinteger nullable

Unix timestamp in milliseconds

isArchivedboolean nullable
archivedTSinteger nullable

Unix timestamp in milliseconds

isDeployEnabledboolean nullable
teamobject nullable
gitobject nullable
ordinteger

Unix timestamp in milliseconds

specstring
updTSinteger

Unix timestamp in milliseconds

updUIDstring

Response

OK — IServerResponse<Product>

codeinteger required
srvTSinteger required

Server timestamp (ms)

rkeystring required

Request key

Example response

{
  "code": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.