Documentation de Maildrop

Client.Update

URL https://api.dpmail.fr/json/Client.Update.php

Les requêtes vers ce endpoint doivent être authentifiées avec une PartnerApiKey.

Effectue une mise à jour des informations d'un compte client. Seules les valeurs des champs passées en paramètre sont mises à jour.

Paramètres et infos requises

client_api_key - String
La ClientApiKey du compte à mettre à jour.

name - String
Optionnel. Le nom du compte.

company_name - String
Optionnel. Le nom de l'entité propriétaire du compte (la raison sociale d'une entreprise par exemple).

address - String
Optionnel. L'adresse postale.

zipcode - String
Optionnel. Le code postal.

city - String
Optionnel. La ville.

emails - Array
Optionnel. Pour le moment il n'existe que la clé "main", permettant de mettre à jour l'adresse email principale du compte.

credits_debit_mode - String
Optionnel. Le mode de consommation des crédits du compte. Le choix se fait entre 2 valeurs:
- MINE : Le compte va consommer vos crédits (ceux de votre compte partenaire)
- THEIRS : Le compte va consommer ses propres crédits.

allowed_quota - Integer
Optionnel. Pour les comptes dont le credits_debit_mode est MINE, permet de fixer le nombre de crédits que le compte est autorisé à utiliser mensuellement.

Format des données en sortie

Un objet contenant toutes les informations concernant le client mis à jour.

{
  "client_api_key": "b9ce325de7ba95ba143d23ba08e5e5a8",
  "name": "ACME",
  "company_name": "ACME Company",
  "address": "4453  Willison Street",
  "zipcode": "93610",
  "city": "Arlington",
  "credits_debit_mode": "THEIRS",
  "credit_balance": 124526,
  "created_on": "2020-04-30T18:36:24+02:00",
  "emails": {
    "main": "hello@acmeco.com"
  },
  "quotas": {
    "allowed": 14253,
    "consumed": 1425,
    "next_reset": "2020-04-30T23:59:59+02:00"
  }
}