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[]	non	Identifiant(s) de la newsletter
idCrmVisitCard	int	non	Identifiant du contact CRM
crmVisitCardEmail	String	non	Email du contact CRM
idUserResponsable	int	non	Identifiant de l'utilisateur responsable
userResponsableEmail	String	non	Email de l'utilisateur responsable
siren	String	non	Numéro SIREN
idCompany	int	non	Identifiant de la société

Réponses

200 — OK

{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {},
    "result": {
        "newsletterContactList": [
            {
                "idNewsletter": "int",
                "idCrmVisitCard": "int",
                "idUserResponsable": "int",
                "deleteKey": "string",
                "subscribeDate": "datetime|null",
                "isDeleted": "boolean",
                "deleteDate": "datetime|null",
                "unsubscribed": "boolean|null",
                "idUserUnsubscribed": "int|null",
                "created": "datetime",
                "modified": "datetime"
            }
        ]
    }
}

400 — Bad Request

{
    "success": false,
    "code": "400",
    "message": "Paramètre incorrect"
}

---

Inscrire un contact à une newsletter

POST /v1/newsletter/contact/subscribe

Inscrit un contact CRM à une 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é
crmVisitCardEmail	String	conditionnel	Email du contact CRM. Obligatoire si idCrmVisitCard n'est pas renseigné
idNewsletter	String	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": "OK",
    "parameters": {},
    "result": {}
}

400 — Bad Request

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

404 — Not Found

{
    "success": false,
    "code": "404",
    "message": "Contact CRM introuvable"
}

---

Désinscrire un contact d'une newsletter

POST /v1/newsletter/contact/unsubscribe

Désinscrit un contact CRM d'une newsletter. L'utilisateur API est enregistré comme auteur de la désinscription.

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é
crmVisitCardEmail	String	conditionnel	Email du contact CRM. Obligatoire si idCrmVisitCard n'est pas renseigné
idNewsletter	String	non	Identifiant de la newsletter. Si non renseigné, désinscription de toutes les newsletters

Réponses

200 — Contact désinscrit

{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {},
    "result": {}
}

400 — Bad Request

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

404 — Not Found

{
    "success": false,
    "code": "404",
    "message": "Contact CRM introuvable"
}