API newsletter
L'API Newsletter permet aux utilisateurs de s'abonner automatiquement aux newsletters de PRO GESTION SOFT directement depuis une plateforme tierce. Grâce à cette API, les entreprises et développeurs peuvent offrir à leurs utilisateurs un moyen simple de rester informés des actualités, mises à jour et nouvelles fonctionnalités de PGS.
Cette API est idéale pour les plateformes souhaitant informer leurs utilisateurs des évolutions de PGS sans effort supplémentaire.
Terminaison
Souscrire aux newsletters
Description de l’endpoint
- Méthode : POST
- URL :
/public/newsletter/subscribe - Description : Permet à un utilisateur de s'inscrire à la newsletter.
- Paramètres de requête :
| Paramètres | Type | Obligatoire | Description |
|---|---|---|---|
lastname | String | Oui | Nom de l'utilisateur |
firstname | String | Oui | Prénom de l'utilisateur |
emailAddress | String | Oui | Adresse e-mail de l'utilisateur |
Exemple de requête
curl -X 'POST' \
'{{baseUrl}}/public/newsletter/subscribe?lastname=Mon%20nom%20de%20famille&firstname=Mon%20prénom&emailAddress=exemple%40gmail.com' \
-H 'accept: application/json' \
-d ''
Réponse attendue (200 - OK)
{
"status": true,
"message": "Vous êtes déjà abonné à notre newsletter."
}
Erreurs possibles
| Code HTTP | Message | Cause |
|---|---|---|
400 | Bad Request | Paramètres manquants ou invalides |
500 | Internal Server Error | Problème interne du serveur |
Cette page vous a-t-elle aidé ?
😓😐😍