Newsletter

Permet de gérer les inscriptions des contacts aux newsletters.

Récupérer les contacts newsletter

GET /v1/newsletter/contact

Retourne la liste des contacts inscrits à une ou plusieurs newsletters.

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Paramètres query

Nom	Type	Requis	Description
idNewsletter	int|int[]	conditionnel	Identifiant(s) de la newsletter
idCrmVisitCard	int|int[]	conditionnel	Identifiant(s) du contact CRM
crmVisitCardEmail	String|String[]	conditionnel	Email(s) du contact CRM
idUserResponsable	int|int[]	conditionnel	Identifiant(s) de l'utilisateur responsable
userResponsableEmail	String|String[]	conditionnel	Email(s) de l'utilisateur responsable
idCompany	int|int[]	conditionnel	Identifiant(s) de la société
siren	String|String[]	conditionnel	Numéro(s) SIREN
isDeleted	boolean	non	Filtrer sur les inscriptions supprimées/désinscrites

TIP

Au moins un paramètre parmi idNewsletter, idCrmVisitCard, crmVisitCardEmail, idUserResponsable, userResponsableEmail, idCompany ou siren est obligatoire.

Réponses

200 — OK

{
    "success": true,
    "parameters": {},
    "newsletterContactList": [
        {
            "idNewsletter": "int",
            "idCrmContact": "int",
            "idCrmVisitCard": "int",
            "idUserResponsable": "int|null",
            "deleteKey": "string|null",
            "subscribeDate": "datetime|null",
            "isDeleted": "bool",
            "deleteDate": "datetime|null",
            "unsubscribed": "bool|null",
            "idUserUnsubscribed": "int|null",
            "created": "datetime",
            "modified": "datetime",
            "crmVisitCard": "<CrmVisitCard>",
            "userResponsable": "<User>|null",
            "userUnsubscribed": "<User>|null",
            "nbSend": "int|null",
            "nbSuccess": "int|null",
            "nbFailure": "int|null"
        }
    ]
}

Notes :

• idCrmContact et idCrmVisitCard contiennent la même valeur (alias).
• crmVisitCard est l'objet contact complet — voir Contacts CRM. userResponsable / userUnsubscribed sont des objets utilisateur (idUser, firstName, lastName, email…).
• nbSend, nbSuccess, nbFailure sont les statistiques d'envoi pour ce contact.

400 — Bad Request

{
    "success": false,
    "message": "Paramètre idNewsletter, idCrmVisitCard, crmVisitCardEmail, idUserResponsable, userResponsableEmail, idCompany ou siren nécessaire",
    "parameters": {}
}

403 — Forbidden

{
    "success": false,
    "code": 403,
    "message": "L'abonnement n'a pas accès à ces données",
    "parameters": {}
}

---

Inscrire un contact à une newsletter

POST /v1/newsletter/contact/subscribe

Inscrit un contact CRM à une newsletter. L'inscription crée (ou met à jour) également l'action de séquence associée à la newsletter.

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Body (JSON)

Nom	Type	Requis	Description
idCrmVisitCard	int	conditionnel	Identifiant du contact CRM. Obligatoire si crmVisitCardEmail n'est pas renseigné (alias accepté : idContact)
crmVisitCardEmail	String	conditionnel	Email du contact CRM. Obligatoire si idCrmVisitCard n'est pas renseigné (alias accepté : contactEmail)
idNewsletter	int	oui	Identifiant de la newsletter
idUserResponsable	int	conditionnel	Identifiant du responsable. Obligatoire si userResponsableEmail n'est pas renseigné
userResponsableEmail	String	conditionnel	Email du responsable. Obligatoire si idUserResponsable n'est pas renseigné

Réponses

200 — Contact inscrit

{
    "success": true,
    "code": 200,
    "message": "Contact inscrit avec succès",
    "newsletterContact": "<NewsletterContact>",
    "sequenceAction": "<SequenceAction>",
    "idSequenceAction": "int",
    "parameters": {}
}

newsletterContact a la structure décrite dans GET /v1/newsletter/contact ; sequenceAction celle décrite dans Actions de séquence.

400 — Bad Request

{
    "success": false,
    "code": "400",
    "message": "Le paramètre idNewsletter est requis"
}

---

Désinscrire un contact d'une newsletter

POST /v1/newsletter/contact/unsubscribe

Désinscrit un contact CRM d'une ou plusieurs newsletters. L'utilisateur API est enregistré comme auteur de la désinscription (idUserUnsubscribed).

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Body (JSON)

Nom	Type	Requis	Description
idCrmVisitCard	int	conditionnel	Identifiant du contact CRM. Obligatoire si crmVisitCardEmail n'est pas renseigné (alias accepté : idContact)
crmVisitCardEmail	String	conditionnel	Email du contact CRM. Obligatoire si idCrmVisitCard n'est pas renseigné (alias accepté : contactEmail)
idNewsletter	int	non	Identifiant de la newsletter. Si non renseigné, désinscription de toutes les newsletters du contact

Réponses

201 — Contact désinscrit

{
    "success": true,
    "code": 201,
    "message": "Contact(s) désinscrit(s) avec succès",
    "newsletterContactList": ["<NewsletterContact>"],
    "parameters": {}
}

newsletterContactList contient les inscriptions désinscrites, avec la structure décrite dans GET /v1/newsletter/contact.

400 — Bad Request

{
    "success": false,
    "code": "400",
    "message": "Un idCrmVisitCard ou crmVisitCardEmail est nécessaire pour mettre à jour un contact sur une newsletter",
    "parameters": {}
}