开发者文档

修改种草项目

PATCH/api/orgs/:orgId/projects/:id

权限与前置条件

所有者、管理员、项目创建人或当前负责人。

支持账号中心 API Key:Authorization: Bearer <ltak_…>。中心每次实时校验,仍执行当前用户的工作区角色和业务权限。Cookie 写入仍需允许来源的 Origin 和 X-Requested-With: suren360。不能同时携带 Cookie 与 API Key。所有路径参数须使用真实 ID。

请求参数

orgId · 路径参数 · 必填字符串

id · 路径参数 · 必填字符串

JSON 请求体

字段类型必填约束
namestring是{"minLength":1,"maxLength":120}
responsibleUserId联合类型是{"anyOf":[{"type":"string","minLength":1,"maxLength":32},{"type":"null"}]}
startsOnstring是{"format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}
endsOnstring是{"format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}
budgetFeninteger是{"minimum":0,"maximum":2147483647}
platformstring是{"enum":["小红书","抖音","微信视频号","微信公众号","微信贴图","多平台"]}
statusstring否{"default":"planning","enum":["planning","active","completed","archived"]}
notesstring否{"default":"","maxLength":5000}
查看完整请求 JSON Schema
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "responsibleUserId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 32
        },
        {
          "type": "null"
        }
      ]
    },
    "startsOn": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
    },
    "endsOn": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
    },
    "budgetFen": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "platform": {
      "type": "string",
      "enum": [
        "小红书",
        "抖音",
        "微信视频号",
        "微信公众号",
        "微信贴图",
        "多平台"
      ]
    },
    "status": {
      "default": "planning",
      "type": "string",
      "enum": [
        "planning",
        "active",
        "completed",
        "archived"
      ]
    },
    "notes": {
      "default": "",
      "type": "string",
      "maxLength": 5000
    }
  },
  "required": [
    "name",
    "responsibleUserId",
    "startsOn",
    "endsOn",
    "budgetFen",
    "platform"
  ],
  "additionalProperties": false
}

调用示例

先在统一账号中心创建 Key,并授权素人种草 360 应用,将密钥安全设置为 LINGTU_API_KEY 环境变量。 请替换部署地址与示例字段,不要将凭证粘贴到聊天或日志中。

cURL · 示例占位值需替换
curl --request PATCH \
  'https://YOUR_DEPLOYMENT_HOST/api/orgs/YOUR_orgId/projects/YOUR_id' \
  --header "Authorization: Bearer $LINGTU_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "替换为实际值",
  "responsibleUserId": "替换为实际值",
  "startsOn": "替换为实际值",
  "endsOn": "替换为实际值",
  "budgetFen": 0,
  "platform": "小红书"
}'

响应结构

成功返回 HTTP 200 的 JSON 对象。下方为响应结构定义,不是虚构的业务数据。

字段类型必填约束
projectobject是{"required":["id","organizationId","name","responsibleUserId","responsibleName","startsOn","endsOn","budgetFen","platform","status","notes","canEdit","createdAt","updatedAt"],"additionalProperties":false}
查看完整响应 JSON Schema
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "project": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "organizationId": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "responsibleUserId": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "responsibleName": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "startsOn": {
          "type": "string"
        },
        "endsOn": {
          "type": "string"
        },
        "budgetFen": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "platform": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "planning",
            "active",
            "completed",
            "archived"
          ]
        },
        "notes": {
          "type": "string"
        },
        "canEdit": {
          "type": "boolean"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
        }
      },
      "required": [
        "id",
        "organizationId",
        "name",
        "responsibleUserId",
        "responsibleName",
        "startsOn",
        "endsOn",
        "budgetFen",
        "platform",
        "status",
        "notes",
        "canEdit",
        "createdAt",
        "updatedAt"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "project"
  ],
  "additionalProperties": false
}
查看错误码与重试规则