Skip to main content

PATCH, POST | Modifier un domaine

Modifier les informations d'un domaine en fonction de son nom

https://mail-rp.com/api/v1/{api-key}/domains/{name}/edit

Parameters
Nom Description
api-key Valeur de votre clé API
name Nom du domaine


Request Body
{
	"public": true|false,
	"carnet": true|false,
	"manager": "adresse email du manager" // Mettre null si aucun manager
}
Exemple
{
	"carnet": true,
	"manager": "contact@xelyos.fr"
}

Pour ne pas modifier une valeur, retirez le champ de la requête


Responses
{
	"name": "nom du domaine",
	"public": true|false,
	"createdAt": "date de création du domaine",
	"updatedAt": "date de la dernière modification du domaine",
	"managedBy": { // Peut être null
		"email": "email du manager",
		"name": "nom du manager",
		"firstname": "prenom du manager",
		"userDiscord": { // Peut être null
			"uuid": "ID du compte discord lié à l'utilisateur",
			"name": "pseudo du compte discord lié à l'utilisateur",
			"avatarURL": "url du compte discord lié à l'utilisateur"
		}
	},
	"activated": true|false,
	"enableCarnet": true|false,
	"usersCount": "nombre d'utilisateur dans le domaine (integer)"
	"newslettersCount": "nombre de newsletters dans le domaine (integer)"
}
Exemple
{
	"name": "xelyos.fr",
	"public": false,
	"createdAt": "2024-01-24T01:29:18+01:00",
	"updatedAt": "2024-01-24T02:29:18+01:00",
	"managedBy": {
		"email": "contact@xelyos.fr",
		"name": "Xelyos",
		"firstname": "Contact",
		"userDiscord": null
	},
	"activated": true,
	"enableCarnet": true,
	"newsletters": 0,
	"newslettersCount": 1
}