Purelymail API

https://news.purelymail.com/api/
Admin
Purelymail API provides endpoints to manage email users, domains, routing rules, password resets,...
Tokens:4,777
Snippets:47
Trust Score:8.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get User Request and Response

Source: https://news.purelymail.com/api/index.html

Request to retrieve user details and the expected response schema.

```json
{
  "userName": "string"
}
```

```json
{
  "result": {
    "enableSearchIndexing": true,
    "recoveryEnabled": true,
    "requireTwoFactorAuthentication": true,
    "enableSpamFiltering": true,
    "resetMethods": [
      {
        "type": {},
        "target": "string",
        "description": "string",
        "allowMfaReset": true
      }
    ]
  }
}
```

--------------------------------

### Get Ownership Code Response

Source: https://news.purelymail.com/api/index.html

Successful response containing the ownership code string.

```json
{
  "result": {
    "code": "string"
  }
}
```

--------------------------------

### Get Ownership Code Request

Source: https://news.purelymail.com/api/index.html

Empty request body for retrieving the domain ownership proof record.

```json
{}
```

--------------------------------

### POST /api/v0/updateDomainSettings

Source: https://news.purelymail.com/api/index.html

Updates settings for an existing owned domain.

```APIDOC
## POST /api/v0/updateDomainSettings

### Description
Updates settings for an existing owned domain.

### Method
POST

### Endpoint
/api/v0/updateDomainSettings

### Request Body
- **name** (string) - Required - The domain name.
- **allowAccountReset** (boolean) - Optional - Whether to allow account reset.
- **symbolicSubaddressing** (boolean) - Optional - Whether to enable symbolic subaddressing.
- **recheckDns** (boolean) - Optional - Whether to trigger a DNS recheck.

### Request Example
{
  "name": "string",
  "allowAccountReset": true,
  "symbolicSubaddressing": true,
  "recheckDns": false
}

### Response
#### Success Response (200)
- **result** (object) - Empty object indicating success.
```

--------------------------------

### POST /api/v0/createUser

Source: https://news.purelymail.com/api/index.html

Creates a new user in the system.

```APIDOC
## POST /api/v0/createUser

### Description
Creates a new user.

### Method
POST

### Endpoint
/api/v0/createUser

### Request Body
- **userName** (string) - Required
- **domainName** (string) - Required
- **password** (string) - Required
- **enablePasswordReset** (boolean) - Optional
- **recoveryEmail** (string) - Optional
- **recoveryEmailDescription** (string) - Optional
- **recoveryPhone** (string) - Optional
- **recoveryPhoneDescription** (string) - Optional
- **enableSearchIndexing** (boolean) - Optional
- **sendWelcomeEmail** (boolean) - Optional

### Response
#### Success Response (200)
- **result** (object) - Result of operation
```

--------------------------------

### List Users Request and Response

Source: https://news.purelymail.com/api/index.html

Request to list users and the corresponding response structure.

```json
{}
```

```json
{
  "result": {
    "users": [
      "string"
    ]
  }
}
```

--------------------------------

### Create User Request

Source: https://news.purelymail.com/api/index.html

JSON payload for creating a new user.

```json
{
  "userName": "string",
  "domainName": "string",
  "password": "string",
  "enablePasswordReset": true,
  "recoveryEmail": "string",
  "recoveryEmailDescription": "string",
  "recoveryPhone": "string",
  "recoveryPhoneDescription": "string",
  "enableSearchIndexing": true,
  "sendWelcomeEmail": true
}
```

--------------------------------

### Add Domain Request and Response

Source: https://news.purelymail.com/api/index.html

Request body to add a domain and the success response.

```json
{
  "domainName": "string"
}
```

```json
{
  "result": {}
}
```

--------------------------------

### POST /api/v0/listRoutingRules

Source: https://news.purelymail.com/api/index.html

Lists all routing rules active under the account.

```APIDOC
## POST /api/v0/listRoutingRules

### Description
Lists all routing rules active under your account.

### Method
POST

### Endpoint
/api/v0/listRoutingRules

### Request Body
- No parameters required.

### Request Example
{}

### Response
#### Success Response (200)
- **result** (object) - Contains the list of rules.

#### Response Example
{
  "result": {
    "rules": [
      {
        "id": 0,
        "domainName": "string",
        "prefix": true,
        "matchUser": "string",
        "targetAddresses": ["string"],
        "catchall": true
      }
    ]
  }
}
```

--------------------------------

### Create Routing Rule Request and Response

Source: https://news.purelymail.com/api/index.html

Request body to create a routing rule and the success response.

```json
{
  "domainName": "string",
  "prefix": true,
  "matchUser": "string",
  "targetAddresses": [
    "string"
  ],
  "catchall": false
}
```

```json
{
  "result": {}
}
```

--------------------------------

### List Routing Rules Request and Response

Source: https://news.purelymail.com/api/index.html

Request body to list all routing rules and the response containing the rules.

```json
{}
```

```json
{
  "result": {
    "rules": [
      {
        "id": 0,
        "domainName": "string",
        "prefix": true,
        "matchUser": "string",
        "targetAddresses": [
          "string"
        ],
        "catchall": true
      }
    ]
  }
}
```

--------------------------------

### Create App Password Request and Response

Source: https://news.purelymail.com/api/index.html

Request body to create a new app password and the corresponding success response.

```json
{
  "userHandle": "string",
  "name": ""
}
```

```json
{
  "result": {
    "appPassword": "string"
  }
}
```

--------------------------------

### POST /api/v0/listDomains

Source: https://news.purelymail.com/api/index.html

Lists all domains accessible to the account.

```APIDOC
## POST /api/v0/listDomains

### Description
Lists domains accessible to an account, possibly including shared domains.

### Method
POST

### Endpoint
/api/v0/listDomains

### Request Body
- **includeShared** (boolean) - Optional - Whether to include shared domains in the list.

### Request Example
{
  "includeShared": false
}

### Response
#### Success Response (200)
- **result** (object) - Contains a list of domains.

#### Response Example
{
  "result": {
    "domains": [
      {
        "name": "string",
        "allowAccountReset": true,
        "symbolicSubaddressing": true,
        "isShared": true,
        "dnsSummary": {
          "passesMx": true,
          "passesSpf": true,
          "passesDkim": true,
          "passesDmarc": true
        }
      }
    ]
  }
}
```

--------------------------------

### Check Account Credit Response

Source: https://news.purelymail.com/api/index.html

Successful response containing the account credit as a string.

```json
{
  "result": {
    "credit": "string"
  }
}
```

--------------------------------

### POST /api/v0/addDomain

Source: https://news.purelymail.com/api/index.html

Adds a domain to the account.

```APIDOC
## POST /api/v0/addDomain

### Description
Adds a domain, assuming it passes DNS checks.

### Method
POST

### Endpoint
/api/v0/addDomain

### Request Body
- **domainName** (string) - Required - The domain name to add.

### Request Example
{
  "domainName": "string"
}

### Response
#### Success Response (200)
- **result** (object) - Empty object indicating success.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### List Password Reset Methods Request and Response

Source: https://news.purelymail.com/api/index.html

Request to list password reset methods and the corresponding response.

```json
{
  "userName": "string"
}
```

```json
{
  "result": {
    "users": [
      {
        "type": "string",
        "target": "string",
        "description": "string",
        "allowMfaReset": true
      }
    ]
  }
}
```

--------------------------------

### POST /api/v0/checkAccountCredit

Source: https://news.purelymail.com/api/index.html

Returns the current account credit balance.

```APIDOC
## POST /api/v0/checkAccountCredit

### Description
Returns current account credit, as a BigDecimal string with precision 64.

### Method
POST

### Endpoint
/api/v0/checkAccountCredit

### Request Body
- (empty) - No parameters required

### Response
#### Success Response (200)
- **result** (object) - Contains the credit balance.

#### Response Example
{
  "result": {
    "credit": "string"
  }
}
```

--------------------------------

### List Domains Response

Source: https://news.purelymail.com/api/index.html

Successful response containing a list of domain objects with DNS status summaries.

```json
{
  "result": {
    "domains": [
      {
        "name": "string",
        "allowAccountReset": true,
        "symbolicSubaddressing": true,
        "isShared": true,
        "dnsSummary": {
          "passesMx": true,
          "passesSpf": true,
          "passesDkim": true,
          "passesDmarc": true
        }
      }
    ]
  }
}
```

--------------------------------

### POST /api/v0/createRoutingRule

Source: https://news.purelymail.com/api/index.html

Creates a new routing rule for a domain.

```APIDOC
## POST /api/v0/createRoutingRule

### Description
Creates a new routing rule for a domain.

### Method
POST

### Endpoint
/api/v0/createRoutingRule

### Request Body
- **domainName** (string) - Required - The domain name.
- **prefix** (boolean) - Required - Whether to use a prefix.
- **matchUser** (string) - Required - The user to match.
- **targetAddresses** (array) - Required - List of target email addresses.
- **catchall** (boolean) - Required - Whether this is a catchall rule.

### Request Example
{
  "domainName": "string",
  "prefix": true,
  "matchUser": "string",
  "targetAddresses": ["string"],
  "catchall": false
}

### Response
#### Success Response (200)
- **result** (object) - Empty object indicating success.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### POST /api/v0/listUser

Source: https://news.purelymail.com/api/index.html

Lists all users under the account.

```APIDOC
## POST /api/v0/listUser

### Description
Lists all users under your account (up to 1000).

### Method
POST

### Endpoint
/api/v0/listUser

### Response
#### Success Response (200)
- **result** (object) - Contains a list of users
  - **users** (array) - List of user names
```

--------------------------------

### API Version and Format

Source: https://news.purelymail.com/api/index.html

Version and specification format for the Purelymail API.

```text
 0.0.1 
```

```text
OAS3
```

--------------------------------

### Generic Success Response

Source: https://news.purelymail.com/api/index.html

Standard response format for successful operations.

```json
{
  "result": {}
}
```

--------------------------------

### POST /api/v0/createAppPassword

Source: https://news.purelymail.com/api/index.html

Creates a new app password for a user.

```APIDOC
## POST /api/v0/createAppPassword

### Description
Creates a new app password.

### Method
POST

### Endpoint
/api/v0/createAppPassword

### Request Body
- **userHandle** (string) - Required - The user handle.
- **name** (string) - Required - The name for the app password.

### Request Example
{
  "userHandle": "string",
  "name": ""
}

### Response
#### Success Response (200)
- **result** (object) - The result of the operation.
- **appPassword** (string) - The generated app password.

#### Response Example
{
  "result": {
    "appPassword": "string"
  }
}
```

--------------------------------

### Update Domain Settings Request

Source: https://news.purelymail.com/api/index.html

Request body to update settings for an existing owned domain.

```json
{
  "name": "string",
  "allowAccountReset": true,
  "symbolicSubaddressing": true,
  "recheckDns": false
}
```

--------------------------------

### POST /api/v0/listPasswordReset

Source: https://news.purelymail.com/api/index.html

Lists all password reset methods for a user.

```APIDOC
## POST /api/v0/listPasswordReset

### Description
Lists all password reset methods for a user.

### Method
POST

### Endpoint
/api/v0/listPasswordReset

### Request Body
- **userName** (string) - Required

### Response
#### Success Response (200)
- **result** (object) - Contains a list of reset methods
```

--------------------------------

### POST /api/v0/listPasswordReset

Source: https://news.purelymail.com/api/index.html

Lists all password reset methods for a user.

```APIDOC
## POST /api/v0/listPasswordReset

### Description
Lists all password reset methods for a user.

### Method
POST

### Endpoint
/api/v0/listPasswordReset

### Request Body
- **userName** (string) - Required - The username.

### Request Example
{
  "userName": "string"
}

### Response
#### Success Response (200)
- **result** (object) - Contains the list of reset methods.

#### Response Example
{
  "result": {
    "users": [
      {
        "type": "string",
        "target": "string",
        "description": "string",
        "allowMfaReset": true
      }
    ]
  }
}
```

--------------------------------

### List Domains Request

Source: https://news.purelymail.com/api/index.html

Request body to list domains, with an option to include shared domains.

```json
{
  "includeShared": false
}
```

--------------------------------

### POST /api/v0/deleteDomain

Source: https://news.purelymail.com/api/index.html

Deletes a domain and all associated settings and users.

```APIDOC
## POST /api/v0/deleteDomain

### Description
Deletes a domain, and all dependent settings and users.

### Method
POST

### Endpoint
/api/v0/deleteDomain

### Request Body
- **name** (string) - Required - The domain name to delete.

### Request Example
{
  "name": "string"
}

### Response
#### Success Response (200)
- **result** (object) - Empty object indicating success.
```

--------------------------------

### POST /api/v0/getUser

Source: https://news.purelymail.com/api/index.html

Retrieves details of a specific user.

```APIDOC
## POST /api/v0/getUser

### Description
Retrieves details of a user.

### Method
POST

### Endpoint
/api/v0/getUser

### Request Body
- **userName** (string) - Required

### Response
#### Success Response (200)
- **result** (object) - User details including search indexing, recovery status, and reset methods.
```

--------------------------------

### POST /api/v0/getOwnershipCode

Source: https://news.purelymail.com/api/index.html

Retrieves the DNS record value required to verify domain ownership.

```APIDOC
## POST /api/v0/getOwnershipCode

### Description
Gets the DNS record value of the Purelymail ownership proof record, required to add a domain.

### Method
POST

### Endpoint
/api/v0/getOwnershipCode

### Request Body
- (empty) - No parameters required

### Response
#### Success Response (200)
- **result** (object) - The result of the operation containing the ownership code.

#### Response Example
{
  "result": {
    "code": "string"
  }
}
```

--------------------------------

### Modify User Request

Source: https://news.purelymail.com/api/index.html

JSON payload for updating user settings.

```json
{
  "userName": "string",
  "newUserName": "string",
  "newPassword": "string",
  "enableSearchIndexing": true,
  "enablePasswordReset": true,
  "requireTwoFactorAuthentication": true
}
```

--------------------------------

### POST /api/v0/upsertPasswordReset

Source: https://news.purelymail.com/api/index.html

Creates or updates a password reset method.

```APIDOC
## POST /api/v0/upsertPasswordReset

### Description
Creates or updates a password reset method (either phone or email).

### Method
POST

### Endpoint
/api/v0/upsertPasswordReset

### Request Body
- **userName** (string) - Required
- **existingTarget** (string) - Optional
- **type** (string) - Required
- **target** (string) - Required
- **description** (string) - Optional
- **allowMfaReset** (boolean) - Optional

### Response
#### Success Response (200)
- **result** (object) - Result of operation
```

--------------------------------

### POST /api/v0/upsertPasswordReset

Source: https://news.purelymail.com/api/index.html

Creates or updates a password reset method for a user.

```APIDOC
## POST /api/v0/upsertPasswordReset

### Description
Creates or updates a password reset method (either phone or email).

### Method
POST

### Endpoint
/api/v0/upsertPasswordReset

### Request Body
- **userName** (string) - Required - The username.
- **existingTarget** (string) - Required - The existing target to update.
- **type** (string) - Required - The type of reset method.
- **target** (string) - Required - The target address or number.
- **description** (string) - Optional - Description of the method.
- **allowMfaReset** (boolean) - Optional - Whether to allow MFA reset.

### Request Example
{
  "userName": "string",
  "existingTarget": "string",
  "type": "string",
  "target": "string",
  "description": "",
  "allowMfaReset": true
}

### Response
#### Success Response (200)
- **result** (object) - Empty object indicating success.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### POST /api/v0/deleteUser

Source: https://news.purelymail.com/api/index.html

Deletes an existing user.

```APIDOC
## POST /api/v0/deleteUser

### Description
Deletes a user.

### Method
POST

### Endpoint
/api/v0/deleteUser

### Request Body
- **userName** (string) - Required

### Response
#### Success Response (200)
- **result** (object) - Result of operation
```

--------------------------------

### Delete Domain Request

Source: https://news.purelymail.com/api/index.html

Request body specifying the domain name to delete.

```json
{
  "name": "string"
}
```

--------------------------------

### Upsert Password Reset Request and Response

Source: https://news.purelymail.com/api/index.html

Request body to create or update a password reset method and the success response.

```json
{
  "userName": "string",
  "existingTarget": "string",
  "type": "string",
  "target": "string",
  "description": "",
  "allowMfaReset": true
}
```

```json
{
  "result": {}
}
```

--------------------------------

### Delete User Request

Source: https://news.purelymail.com/api/index.html

JSON payload for deleting an existing user.

```json
{
  "userName": "string"
}
```

--------------------------------

### POST /api/v0/modifyUser

Source: https://news.purelymail.com/api/index.html

Modifies an existing user's settings.

```APIDOC
## POST /api/v0/modifyUser

### Description
Modifies a user.

### Method
POST

### Endpoint
/api/v0/modifyUser

### Request Body
- **userName** (string) - Required
- **newUserName** (string) - Optional
- **newPassword** (string) - Optional
- **enableSearchIndexing** (boolean) - Optional
- **enablePasswordReset** (boolean) - Optional
- **requireTwoFactorAuthentication** (boolean) - Optional

### Response
#### Success Response (200)
- **result** (object) - Result of operation
```

--------------------------------

### POST /api/v0/deletePasswordReset

Source: https://news.purelymail.com/api/index.html

Deletes a password reset method.

```APIDOC
## POST /api/v0/deletePasswordReset

### Description
Deletes a password reset method.

### Method
POST

### Endpoint
/api/v0/deletePasswordReset

### Request Body
- **userName** (string) - Required
- **target** (string) - Required

### Response
#### Success Response (200)
- **result** (object) - Result of operation
```

--------------------------------

### POST /api/v0/deletePasswordReset

Source: https://news.purelymail.com/api/index.html

Deletes a password reset method.

```APIDOC
## POST /api/v0/deletePasswordReset

### Description
Deletes a password reset method.

### Method
POST

### Endpoint
/api/v0/deletePasswordReset

### Request Body
- **userName** (string) - Required - The username.
- **target** (string) - Required - The target to delete.

### Request Example
{
  "userName": "string",
  "target": "string"
}

### Response
#### Success Response (200)
- **result** (object) - Empty object indicating success.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### Delete App Password Request and Response

Source: https://news.purelymail.com/api/index.html

Request body to delete an existing app password and the success response.

```json
{
  "userName": "string",
  "appPassword": "string"
}
```

```json
{
  "result": {}
}
```

--------------------------------

### Delete Password Reset Request and Response

Source: https://news.purelymail.com/api/index.html

Request body to delete a password reset method and the success response.

```json
{
  "userName": "string",
  "target": "string"
}
```

```json
{
  "result": {}
}
```

--------------------------------

### POST /api/v0/deleteAppPassword

Source: https://news.purelymail.com/api/index.html

Deletes an existing app password.

```APIDOC
## POST /api/v0/deleteAppPassword

### Description
Deletes an app password.

### Method
POST

### Endpoint
/api/v0/deleteAppPassword

### Request Body
- **userName** (string) - Required - The username.
- **appPassword** (string) - Required - The app password to delete.

### Request Example
{
  "userName": "string",
  "appPassword": "string"
}

### Response
#### Success Response (200)
- **result** (object) - Empty object indicating success.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### Delete Password Reset Request

Source: https://news.purelymail.com/api/index.html

JSON payload for deleting a password reset method.

```json
{
  "userName": "string",
  "target": "string"
}
```

--------------------------------

### POST /api/v0/deleteRoutingRule

Source: https://news.purelymail.com/api/index.html

Deletes an existing routing rule.

```APIDOC
## POST /api/v0/deleteRoutingRule

### Description
Deletes an existing routing rule.

### Method
POST

### Endpoint
/api/v0/deleteRoutingRule

### Request Body
- **routingRuleId** (integer) - Required - The ID of the routing rule.

### Request Example
{
  "routingRuleId": 0
}

### Response
#### Success Response (200)
- **result** (object) - Empty object indicating success.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### Upsert Password Reset Request

Source: https://news.purelymail.com/api/index.html

JSON payload for creating or updating a password reset method.

```json
{
  "userName": "string",
  "existingTarget": "string",
  "type": "string",
  "target": "string",
  "description": "",
  "allowMfaReset": true
}
```

--------------------------------

### Delete Routing Rule Request and Response

Source: https://news.purelymail.com/api/index.html

Request body to delete a routing rule by ID and the success response.

```json
{
  "routingRuleId": 0
}
```

```json
{
  "result": {}
}
```
Tokens:
Raw