Skip to main content

POST | Ajouter un domaine

Ajouter un domaine

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

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


Request Body
{
	"name": "nom du domaine",
	"public": true|false,
	"carnet": true|false
}
Exemple
{
	"name": "xelyos.fr",
	"public": false,
	"carnet": true
}

Il est également possible de créer le domaine en définissant directement un manager

{
	"name": "nom du domaine",
	"public": true|false,
	"carnet": true|false,
	"manager": {
		"email": "email du manager",
		"name": "nom du manager",
		"firstname": "prénom du manager",
		"password": "mot de passe"
	}
}
Exemple
{
	"name": "xelyos.fr",
	"public": false,
	"carnet": true,
	"manager": {
		"email": "aros@xelyos.fr",
		"name": "Xelyos",
		"firstname": "Aros",
		"password": "mot de passe compliqué"
	}
}

Si le domaine de l'adresse du manager est différent du domaine créé, une erreur sera générée 


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": null,
	"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-24T01:29:18+01:00",
	"managedBy": null,
	"activated": true,
	"enableCarnet": false,
	"newsletters": 0,
	"newslettersCount": 0
}

Avec l'ajout d'un manager :

{
	"name": "xelyos.fr",
	"public": false,
	"createdAt": "2024-01-24T01:29:18+01:00",
	"updatedAt": "2024-01-24T01:29:18+01:00",
	"managedBy": {
		"email": "aros@xelyos.fr",
		"name": "Xelyos",
		"firstname": "Aros",
		"userDiscord": null
	},
	"activated": true,
	"enableCarnet": false,
	"newsletters": 0,
	"newslettersCount": 1
}