API Merci Facteur /deleteEnvoi : Annuler un envoi et son contenu

Base URL API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service

Endpoint API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service/deleteEnvoi

← Retour à la liste des endpoints de l'API Merci Facteur

← Voir ce endpoint dans la doc Swagger

DELETE /deleteEnvoiAnnuler un envoi et son contenu
 
Voir dans Swagger →

Attention, opération irrémédiable. Selon le statut actuel des courriers, une demande d'annulation d'envoi pourra être rejetée immédiatement, rejetée après un certain délai, rejetée partiellement (annulation de l'envoi mais facturation partiellement annulée), ou acceptée intégralement (annulation de l'envoi et annulation intégrale de la facturation de cet envoi).

Paramètres

NomInTypeDescription
ww-service-idheaderstringVotre service Id
ww-access-tokenheaderstringUn access token valide
idEnvoiqueryintegerId de l'envoi contenant les courriers à annuler (Id retourné par /sendCourrier)

Request body

Aucun body.

Réponses

HTTP 200 — Objet contenant le résultat de l'opération

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorstringle code d'erreur en cas d'erreur
HTTP 400 — Erreur (code d'erreur dans l'entête)

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorobjectObjet contenant les infos de l'erreur.
PropriétéTypeDescription
codestringle code d'erreur en cas d'erreur
textstringle message d'erreur correspondant
HTTP 401 — Erreur authentification (code d'erreur dans l'entête : token invalide ou expiré, service-id incorrecte, IP non autorisée)

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorobjectObjet contenant les infos de l'erreur.
PropriétéTypeDescription
codestringle code d'erreur en cas d'erreur
textstringle message d'erreur correspondant


imprimé en france depuis 2004