跳到主要内容

POST 更新商机阶段配置

POST 更新。body 为 JSON 对象(含 id)。

接口编码所需范围后端接口
config.sales.opportunity-stage.updateconfig:writePOST /v1/opportunity-stage/update(comap-sales)

必填字段

字段依据
id接口规格
entryConditions[].type接口规格
entryConditions[].timing接口规格
entryConditions[].behavior接口规格
completionConditions[].type接口规格
completionConditions[].timing接口规格
completionConditions[].behavior接口规格

条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。

请求体字段(body)

字段类型必填说明
idinteger(int64)是商机阶段ID
namestring—阶段名称
codestring—阶段编码
colorstring—标识颜色
probabilityinteger(int32)—默认赢率(%)
isWoninteger(int32)—是否赢单阶段(0-否 1-是)
isLostinteger(int32)—是否输单阶段(0-否 1-是)
sortOrderinteger(int32)—排序值
remarkstring—备注
entryConditions5OpportunityStageConditionDTO[]—进入目标阶段前的检查条件
completionConditions5OpportunityStageConditionDTO[]—离开当前阶段前的完成条件
allowedNextStageIdsinteger(int64)[]—允许流转的目标阶段ID(进行中阶段空=仅下一启用阶段,终态空=不可推进)
allowRollbackinteger(int32)—是否允许回退(0-否 1-是)
rollbackRoleIdsinteger(int64)[]—允许回退的角色ID
allowSkipinteger(int32)—是否允许跳跃推进(0-否 1-是)
skipRoleIdsinteger(int64)[]—允许跳跃推进的角色ID
requiredLostReasoninteger(int32)—输单是否必填原因(0-否 1-是;V1 唯一输单阶段强制为 1)
winCheckModestring—赢单前检查模式:NONE/CONTRACT_OR_ORDER/CONTRACT/ORDER
maxStayDaysinteger(int32)—标准停留天数,0-不限制
warningDaysinteger(int32)—提前预警天数,0-不预警
reminderTargetsstring[]—提醒对象配置:OWNER/SALES_MANAGER/ADMIN;提醒方式固定为站内消息,不做配置

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "config.sales.opportunity-stage.update",
"body": {
"id": "1961000000000000001"
}
}'

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 config:write否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败先查询处理结果,禁止盲目重试
92301请求过于频繁是
92205写操作处理超时,结果未知(下游可能仍在执行)否,先查询确认结果
92302有参数相同的写请求正在处理中等待并确认前一次结果,勿重复提交

除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回商机阶段管理