---
updatedAt: 2026-10-13T07:44:58.000Z
agentTools:
  siteIndex: https://developer.rmlconnect.net/llms.txt
  projectIndex: https://developer.rmlconnect.net/route-mobile-project/llms.txt
---

# SMTP Users

> 📘 Do you have any questions on our Email API? Write to us at <support@sendclean.com>

## /settings/addSmtp

Creates a new SMTP user.

### Example Request

```json
{
    "owner_id": "example id",
    "token": "example token",
    "total_limit": 1000,
    "hourly_limit": 100
}
```

### Example Success Response

```json
{
    "status": "success",
    "message": "Smtp User Added",
    "smtp_user_name": "smtp12345",
    "smtp_password": "examplepassword"
}
```

### Example Error Response

```json
{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}
```

### Parameters

| Parameter           | Type    | Description                            |
| ------------------- | ------- | -------------------------------------- |
| **owner\_id**\*     | string  | a valid SendCleanUser Id               |
| **token**\*         | string  | a valid token                          |
| **total\_limit**\*  | integer | total sending limit for the SMTP user  |
| **hourly\_limit**\* | integer | hourly sending limit for the SMTP user |

\*compulsory field

### Return Value: Success

**struct** — the results of adding an SMTP user

| Field                | Type   | Description                  |
| -------------------- | ------ | ---------------------------- |
| **status**           | string | success                      |
| **message**          | string | human readable message       |
| **smtp\_user\_name** | string | newly created SMTP user name |
| **smtp\_password**   | string | newly created SMTP password  |

### Return Value: Error

**struct** — the error results when attempting to add an SMTP user

| Field       | Type   | Description                         |
| ----------- | ------ | ----------------------------------- |
| **status**  | string | error                               |
| **message** | string | human readable message              |
| **type**    | string | one of the error types listed below |

### Error Types

**ValidationError** — The parameters passed to the API call are invalid or not provided when required.

**GeneralError** — An unexpected error occurred processing the request. SendClean Developers will be notified.

**AuthenticationError** — Provided owner\_id and token was not matched.

***

## /settings/editSmtp

Modifies an existing SMTP user.

### Example Request

```json
{
    "owner_id": "example id",
    "token": "example token",
    "smtp_user_name": "smtp12345",
    "total_limit": 2000,
    "hourly_limit": 200,
    "status": "Enable"
}
```

### Example Success Response

```json
{
    "status": "success",
    "message": "Smtp User Updated"
}
```

### Example Error Response

```json
{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}
```

### Parameters

| Parameter              | Type    | Description                  |
| ---------------------- | ------- | ---------------------------- |
| **owner\_id**\*        | string  | a valid SendCleanUser Id     |
| **token**\*            | string  | a valid token                |
| **smtp\_user\_name**\* | string  | a valid SMTP user name       |
| **total\_limit**       | integer | updated total sending limit  |
| **hourly\_limit**      | integer | updated hourly sending limit |
| **status**             | string  | Enable or Disable            |

\*compulsory field

### Return Value: Success

**struct** — the results of editing an SMTP user

| Field       | Type   | Description            |
| ----------- | ------ | ---------------------- |
| **status**  | string | success                |
| **message** | string | human readable message |

### Return Value: Error

**struct** — the error results when attempting to edit an SMTP user

| Field       | Type   | Description                         |
| ----------- | ------ | ----------------------------------- |
| **status**  | string | error                               |
| **message** | string | human readable message              |
| **type**    | string | one of the error types listed below |

### Error Types

**ValidationError** — The parameters passed to the API call are invalid or not provided when required.

**GeneralError** — An unexpected error occurred processing the request. SendClean Developers will be notified.

**AuthenticationError** — Provided owner\_id and token was not matched.

***

## /settings/resetSmtpPassword

Resets the password for an existing SMTP user.

### Example Request

```json
{
    "owner_id": "example id",
    "token": "example token",
    "smtp_user_name": "smtp12345"
}
```

### Example Success Response

```json
{
    "status": "success",
    "message": "Smtp Password Reset",
    "smtp_user_name": "smtp12345",
    "smtp_password": "newexamplepassword"
}
```

### Example Error Response

```json
{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}
```

### Parameters

| Parameter              | Type   | Description              |
| ---------------------- | ------ | ------------------------ |
| **owner\_id**\*        | string | a valid SendCleanUser Id |
| **token**\*            | string | a valid token            |
| **smtp\_user\_name**\* | string | a valid SMTP user name   |

\*compulsory field

### Return Value: Success

**struct** — the results of resetting SMTP password

| Field                | Type   | Description            |
| -------------------- | ------ | ---------------------- |
| **status**           | string | success                |
| **message**          | string | human readable message |
| **smtp\_user\_name** | string | SMTP user name         |
| **smtp\_password**   | string | new SMTP password      |

### Return Value: Error

**struct** — the error results when attempting to reset SMTP password

| Field       | Type   | Description                         |
| ----------- | ------ | ----------------------------------- |
| **status**  | string | error                               |
| **message** | string | human readable message              |
| **type**    | string | one of the error types listed below |

### Error Types

**ValidationError** — The parameters passed to the API call are invalid or not provided when required.

**GeneralError** — An unexpected error occurred processing the request. SendClean Developers will be notified.

**AuthenticationError** — Provided owner\_id and token was not matched.

***

## /settings/listSmtp

Retrieves all SMTP users associated with an account.

### Example Request

```json
{
    "owner_id": "example id",
    "token": "example token"
}
```

### Example Success Response

```json
{
    "status": "success",
    "smtp_data": [
        {
            "smtp_user_name": "smtp12345",
            "smtp_password": "examplepassword",
            "status": "Enable",
            "total_limit": 1000,
            "hourly_limit": 100
        }
    ]
}
```

### Example Error Response

```json
{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}
```

### Parameters

| Parameter       | Type   | Description              |
| --------------- | ------ | ------------------------ |
| **owner\_id**\* | string | a valid SendCleanUser Id |
| **token**\*     | string | a valid token            |

\*compulsory field

### Return Value: Success

**struct** — the results of listing SMTP users

| Field          | Type   | Description                |
| -------------- | ------ | -------------------------- |
| **status**     | string | success                    |
| **smtp\_data** | array  | array of SMTP user objects |

\*\*smtp\_data\[]\*\*fields:

| Field                | Type    | Description          |
| -------------------- | ------- | -------------------- |
| **smtp\_user\_name** | string  | SMTP user name       |
| **smtp\_password**   | string  | SMTP password        |
| **status**           | string  | Enable or Disable    |
| **total\_limit**     | integer | total sending limit  |
| **hourly\_limit**    | integer | hourly sending limit |

### Return Value: Error

**struct** — the error results when attempting to list SMTP users

| Field       | Type   | Description                         |
| ----------- | ------ | ----------------------------------- |
| **status**  | string | error                               |
| **message** | string | human readable message              |
| **type**    | string | one of the error types listed below |

### Error Types

**ValidationError** — The parameters passed to the API call are invalid or not provided when required.

**GeneralError** — An unexpected error occurred processing the request. SendClean Developers will be notified.

**AuthenticationError** — Provided owner\_id and token was not matched.