API Merci Facteur /sendPublipostage : Envoi de la source de données du publipostage

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/sendPublipostage

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

POST /sendPublipostage — Envoi de la source de données du publipostage

Validation de l'envoi d'un publipostage. Cela enclenche la fusion des données, la mise en production, l'impression et l'envoi de l'ensemble des lettres du publipostage.

Paramètres

Nom	In	Type	Description
`ww-service-id`	header	string	Votre service Id
`ww-access-token`	header	string	Un access token valide

Request body

Request body requis

application/x-www-form-urlencoded

Propriété Type Description

idEnvoi integer Identifiant de l'envoi qui vous a été retourné par \sourcePublipostage

idExp integer Id de l'adresse d'expéditeur (créée auparavant avec /setNewAdress) - si vous utilisez "idExp", laissez vide "jsonExp".

jsonExp string json contenant l'adresse d'expéditeur (si vous ne souhaitez pas créer l'adresse auparavant avec /setNewAdress) - si vous utilisez "jsonExp", laissez vide "idExp".

modeEnvoi string Mode d'envoi du courrier : suivi, lrar, lrare, ou normal

anonymize object Facultatif, permet de demander la suppression d\'éléments du courrier un certain délai (en nombre de jours) après l\'impression du courrier. A utiliser si vous ne souhaitez pas que les données des courriers soient conservées sur les serveurs de Merci Facteur. Exemple de valeur : {"delay":15,"target":["content","exp","dest"]} (plus d\'infos ici : https://github.com/MerciFacteur/Merci-facteur-API/#anonymisation)

Propriété	Type	Description
`delay`	integer	Délai en nombre de jours (min. 1, max. 400) à compter de l'impression, après lesquels vous souhaitez que l'anonymisation ai lieu.
`target`	array<string>	Indiquez dans un tableau les éléments à anonymiser/supprimer : ["content","exp","dest"].
Items: Valeurs autorisées : `exp`, `dest`, `content`

Réponses

HTTP 200 — Objet contenant le résumé des envois qui ont été validés

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error string le code d'erreur en cas d'erreur

envoi_id array<integer> L'Id de cet envoi

price object Détail du montant facturé

Propriété Type Description

total object

Propriété	Type	Description
`ht`	string	Montant total HT
`ttc`	string	Montant total TTC

detail object

Propriété	Type	Description
`affranchissement`	string	Montant total de l'affranchissement (ht, tva=0)
`letter`	string	Montant total du contenu lettres (ht, tva=tx standard)
`card`	string	Montant total du contenu cartes (ht, tva=tx standard)

resume object Résumé du contenu de l'envoi

Propriété	Type	Description
`nb_dest`	integer	Nombre de destinataires (= nombre de courriers générés)
`nb_page`	integer	Nombre de page(s) décomptées(s) par destinataire

account object Etat de votre compte après cet envoi

Propriété Type Description

pages object Nombre de pages envoyées dans le mois

Propriété	Type	Description
`thisMonth`	integer	Nombre de pages envoyées ce mois-ci.
`maxMonth`	integer	Nombre maximum de pages que vous pouvez envoyer ce mois-ci.

HTTP 400 — Erreur (code d'erreur dans l'entête)

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error object Objet contenant les infos de l'erreur.

Propriété	Type	Description
`code`	string	le code d'erreur en cas d'erreur
`text`	string	le 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é Type Description

success boolean true si HTTP 200, sinon false

error object Objet contenant les infos de l'erreur.

Propriété	Type	Description
`code`	string	le code d'erreur en cas d'erreur
`text`	string	le message d'erreur correspondant