開発者センター

添付ファイルを削除

POST /esignglobal/v1/envelope/files/deleteAttachments

インターフェースの説明

封筒から添付ファイルを削除します。封筒を開封する前であればいつでも削除できますが、開封後は追加のみ可能で削除はできません。

リクエストパラメータ

パラメータ名

タイプ

必須項目

説明

envelopeId

string

true

封筒ID

attachments

array

true

封筒の添付ファイルコレクション。表示順序はファイルの追加順です。

 

fileKey

string

true

ファイルfileKey

リクエスト例

{
    "envelopeId":"flow1234567890",
    "attachments":[{
    "fileKey":"fileKey12345678901"
  }]
}

レスポンスパラメータ

パラメータ名

タイプ

説明

code

int

業務コード。0は成功、0以外は異常を示します。

message

string

業務情報

【注意】エラー状況はcodeで判断してください。messageのマッチングに依存すべきではありません。messageは調整される可能性があるためです。

data

object

業務データ

レスポンス例

{
    "code": "0",
    "message": "success",
    "data": null
}

 

インターフェースの説明
リクエストパラメータ
リクエスト例
レスポンスパラメータ
レスポンス例