Doc Partner
SMS PartnerVoice PartnerMail PartnerSDKS
Doc Partner - FR
Doc Partner - FR
  • Bienvenue
  • API
    • SMS Partner
      • Crédits
      • Envoyer des SMS
        • Envoi unitaire
        • Envoi par lots
        • Envoi par numéro long
        • Envoi de sondages
        • Annuler l'envoi d'un SMS différé
        • Caractères spéciaux
      • Statut & Statistiques
        • Statut unitaire
        • Statut multiple
        • Statut par message
        • Statut par tag
        • Statistique des envois
      • Gestion des contacts
        • Ajouter un groupe
        • Ajouter un contact
        • Supprimer un groupe
        • Ajouter un lot de contacts
        • Modifier un contact
        • Supprimer un contact
        • Obtenir la liste des groupes
        • Obtenir la liste des contacts
        • Obtenir le détail d'un contact
      • Gestion des réponses / stops
        • Liste des stops
        • Ajouter un numéro au stop SMS
        • Supprimer un numéro du STOP SMS
        • Gestion des réponses
      • Sous-comptes
        • Activation
        • Création d'un sous compte
        • Supprimer un sous-compte
        • Liste des sous-comptes
        • Gérer les crédits des sous-comptes
      • Gérer le transfert d'appel
      • Vérification de numéros
        • Envoyer une vérification
        • Vérification de format
      • Location de contacts
        • Catégories
        • Ciblage et calcul
        • Statut d'une location
        • Télécharger le fichier
      • RCS
    • Voice Partner
      • Crédits
      • Message Vocal
        • Liste des fichiers audio
        • Renommer un fichier audio
        • Déposer un message vocal
      • Envoyer un SMS Vocal
      • Supprimer un envoi différé
    • Mail Partner
      • Crédits
      • Envoi unitaire de mail
      • Annuler l'envoi d'un mail
      • Statut par message
      • Gestion des désabonnements
        • Ajouter un mail
        • Liste des désabonnements
        • Supprimer un mail
      • Sous-comptes
        • Activation
        • Création d'un sous compte
        • Liste des sous-comptes
        • Gérer les crédits des sous-comptes
    • Codes d'erreur
  • SDKS
Propulsé par GitBook

© 2025 NDA Media

Sur cette page
  1. API
  2. Mail Partner
  3. Gestion des désabonnements

Supprimer un mail

Cette requête permet d’ajouter un mail à la liste des désinscriptions.

URL

POST https://api.mailpartner.fr/v1/unsubscribe/delete

Paramètres obligatoires

Nom
Valeur

apiKey

id

Paramètres optionnels

Nom
Valeur

_format

json ou xml

Requête

<?php
 
        // Prepare data for GET request
        $data = 'apiKey=YOUR_API_KEY&id=666';
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.mailpartner.fr/v1/unsubscribe/delete?'.$data);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_TIMEOUT, 10);
 
 
        $result = curl_exec($curl);
        curl_close($curl);
 
        // Process your response here
        echo $result;
?>
Imports System.IO
Imports System.Net
 
Module Module1
 
  Sub Main()
 
    Dim base_url As String = "http://api.mailpartner.fr/v1/"
    Dim apiKey As String = "VOTRE_APIKEY"
    Dim id As Integer = XXX
 
    #check credits
    Dim url As String
    url = base_url & "unsubscribe/delete" & "?apiKey=" & apiKey & "&id=" & id
 
    Dim credits As String
    credits = apiRequest("GET", url, Nothing)
 
  End Sub
 
  Function apiRequest(method As String, url As String, parameters As String) As String
 
    Dim request As HttpWebRequest
    request = WebRequest.Create(url)
    request.Method = method
    request.Timeout = 10000   # timeout in ms
    request.ContentType = "application/json; charset=utf-8"
    request.ContentLength = 0
 
    #set POST data
    If Not String.IsNullOrEmpty(parameters) Then
      request.ContentLength = parameters.Length
      Using reqStream As StreamWriter = New StreamWriter(request.GetRequestStream())
        reqStream.Write(parameters)
      End Using
    End If
 
    #get response
    Dim returnValue As String = Nothing
    Using response As HttpWebResponse = request.GetResponse()
      If response.StatusCode = HttpStatusCode.OK Then
        Using resStream = response.GetResponseStream()
          If resStream IsNot Nothing Then
            Using reader As New StreamReader(resStream)
              returnValue = reader.ReadToEnd()
            End Using
          End If
        End Using
      End If
    End Using
    apiRequest = returnValue
 
  End Function
 
End Module
# std
import logging
import json
from collections import OrderedDict
 
# 3p
import requests
 
API_KEY = "MY API KEY"
URL = "http://api.mailpartner.fr/v1"
 
class SMSPartner():
    def del_stop(self,id):
		url = URL + "/unsubscribe/delete?apiKey=" + API_KEY + "&id=" + id
		r = requests.get(url)
		r_json = r.json()
		if r_json.get("success") == True:
			print(r_json)
			status = True
		else:
			print(r_json)
			status = False
		return status
curl -H  "Content-Type: application/json" -X GET  https://api.mailpartner.fr/v1/unsubscribe/delete?apiKey=xxx&id=300

Réponse

{
    "success": true,
    "code":200
}
<?xml version='1.0' encoding='UTF-8'?>
<result>
    <entry>true</entry>
    <entry>200</entry>
</result>

Erreurs

{
    "success": false,
    "code": 10,
    "message": "Clé API incorrecte"
}
<?xml version='1.0' encoding='UTF-8'?>
<result>
    <entry>false</entry>
    <entry>10</entry>
    <entry>Clé API incorrecte</entry>
</result>

Code erreurs

Code de réponse
Réponse

1

La Clé API est requise

2

3

L’ID du message est requis

4

Le mail et invalide

10

Clé API incorrecte

200

Tout s’est bien passé !

PrécédentListe des désabonnementsSuivantSous-comptes

Dernière mise à jour il y a 2 mois

ID du mail à supprimer. Il se trouve dans

Votre clé API
la réponse lors de la récupération de la liste des désabonnements.