Retrieve Sub-account SMTP Passwords

GET 
https://api.mailchannels.net/tx/v1/sub-account/:handle/smtp-password

Retrieves details of all SMTP passwords associated with the specified sub-account. For security, the full SMTP password is not returned; only the password ID and a partially redacted version are provided.

Request

Path Parameters

handle stringrequired

Handle of the sub-account to retrieve the SMTP password for.

Header Parameters

X-Api-Key stringrequired

Responses

200

Successfully retrieved the SMTP password for the specified sub-account.

application/json

Schema

Schema

• Array [
enabledboolean

Whether the SMTP password is enabled

idinteger

The SMTP password ID for the sub-account

smtp_passwordstring

SMTP password for the sub-account

• ]

Example (auto)

[
  {
    "enabled": true,
    "id": 0,
    "smtp_password": "string"
  }
]

404

The specified sub-account does not exist.

500

An unexpected internal error occurred.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.mailchannels.net/tx/v1/sub-account/:handle/smtp-password");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.mailchannels.net/tx/v1

Parameters

handle — pathrequired

X-Api-Key — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!