Skip to main content
POST
/
organization
/
channels
Create a new channel
curl --request POST \
  --url https://api.getfernand.com/organization/channels \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Support",
  "email": "support@piedpiper.com"
}
'
{
  "id": 12345,
  "name": "Support",
  "email": "support@piedpiper.com",
  "destination": "support@piedpiper.fernand-mails.com",
  "is_valid": true,
  "domain": {
    "name": "piedpiper.com",
    "dns": [
      {}
    ],
    "is_valid": false,
    "is_pending": true
  }
}
Creates a new email channel for the organization with the specified name and email address.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Body

application/json
​
name
string
required

Display name for the channel.

Maximum string length: 50
Example:

"Support"

​
email
string<email>
required

Email address for the channel (domain must not exceed 65 characters).

Maximum string length: 250
Example:

"support@piedpiper.com"

Response

Channel created successfully.

​
id
integer<int64>
required

Unique identifier for the channel

Example:

12345

​
name
string
required

Display name for the channel. Defaults to the local part of the email (before @) if not set.

Maximum string length: 250
Example:

"Support"

​
email
string<email>
required

Email address for this channel

Maximum string length: 250
Example:

"support@piedpiper.com"

​
destination
string<email>
required

The actual email inbox used by Fernand to receive emails. This is where you point your email redirection to.

Example:

"support@piedpiper.fernand-mails.com"

​
is_valid
boolean
required

Whether the channel's domain has been validated and is ready to send/receive emails

Example:

true

​
domain
object

Domain verification details.