Newsletter

Récupère les contacts lié aux newsletter

GET https://api.campaign.coefficy.com/v1/newsletter/contact

Query Parameters

Name	Type	Description
idNewsletter	int|int[]|null
idCrmVisitCard	int
crmVisitCardEmail	String
idUserResponsable	int
userResponsableEmail	String
siren	String
idCompany	int

Headers

Name	Type	Description
x-access-token*	String

200: OK

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

Inscrit un contact existant sur une newsletter

POST https://api.campaign.coefficy.com/v1/newsletter/contact/subscribe

Pour identifier le contact: idCrmVisitCard ou crmVisitCardEmail

Pour identifier le responsable: idUserResponsable ou userResponsableEmail

Headers

Name	Type	Description
x-access-token*	String

Request Body

Name	Type	Description
idCrmVisitCard	int
crmVisitCardEmail	String
idNewsletter*	String
idUserResponsable	int
userResponsableEmail	String

400: Bad Request

404: Not Found

200: OK

{
    "success": true,
    "parameters": {
        ...
    },
    "newsletterContact": <NewsletterContact>,
    "sequenceAction": <SequenceAction>
}

Désinscrit un contact existant sur une newsletter

POST https://api.campaign.coefficy.com/v1/newsletter/contact/unsubscribe

Paramètre idCrmVisitCard ou crmVisitCardEmail pour cibler le contact.

idNewsletter optionnel, si non renseigné désinscrit de toutes les newsletter.

L'utilisateur de l'api est marqué en tant que personne qui a désinscrit le contact.

Headers

Name	Type	Description
x-access-token*	String

Request Body

Name	Type	Description
idCrmVisitCard	int
crmVisitCardEmail	String
idNewsletter	String