删除签署区

更新时间：2023-11-02 16:28:30

接口描述

调用此接口可以向已创建的签署流程中删除指定的签署区（仅限于未签署状态下的签署区）。

接口地址&请求方法

接口地址：https://{host}/v3/sign-flow/{signFlowId}/signers/sign-fields?signFieldIds=xxx1,xxx2

请求方法：DELETE

请求头格式

具体请求头参数，请查看公共请求头格式。

请求参数

参数名称

参数类型

必选

参数位置

参数说明

signFlowId

string

是

path

签署流程ID

signFieldIds

string

是

query

签署区ID（多个签署区请使用英文逗号分隔）

补充说明：

需要用《查询签署流程详情》接口查询对应的签署区ID（signFieldId）

响应参数

展开全部参数参数名称			参数类型	必选	参数说明
code			int32	是	业务码，0表示成功，非0表示异常。
message			string	否	业务信息请根据 code 来判断错误情况，不应该依赖message 匹配，因为 message 可能会调整。
data（点击“+”展开详情）			object	否	业务数据
	deleteResults		array	否	签署区删除结果
	signFieldId	string	否	签署区ID
	deleteResult	string	否	操作结果：0 - 成功，1 - 失败
	failedReason	string	否	失败的原因

请求示例

DELETE https://openapi.esign.cn/v3/sign-flow/a9084f2**78ad0/signers/sign-fields?signFieldIds=97913b**6ccae5da

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "deleteResults": [
            {
                "signFieldId": "a7dd3835c*****25b59d39",
                "deleteResult": 0,
                "failedReason": null
            }
        ]
    }
}

错误码

点击查看错误码