Centre de développement

Supprimer la pièce jointe

POST /esignglobal/v1/envelope/files/deleteAttachments

Description de l'interface

Supprime les pièces jointes d'une enveloppe. La suppression est possible à tout moment avant l'ouverture de l'enveloppe. Une fois l'enveloppe ouverte, il est possible d'ajouter des pièces jointes, mais pas de les supprimer.

Paramètres de la requête

Nom du paramètre

Type

Obligatoire

Description

envelopeId

string

true

ID de l'enveloppe

attachments

array

true

Collection de pièces jointes de l'enveloppe, l'ordre d'affichage correspond à l'ordre d'ajout des fichiers.

 

fileKey

string

true

Clé de fichier (fileKey)

Exemple de requête

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

Paramètres de la réponse

Nom du paramètre

Type

Explication

code

int

Code métier, 0 signifie succès, une valeur différente de 0 signifie exception.

message

string

Informations métier

【注意】Veuillez déterminer la situation d'erreur en fonction du code, vous ne devez pas dépendre de la correspondance des messages, car le message peut être ajusté

data

object

Données métier

Exemple de réponse

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

 

Description de l'interface
Paramètres de la requête
Exemple de requête
Paramètres de la réponse
Exemple de réponse