Skip to main content
PATCH
/
organization
/
channels
/
{email}
Update a channel's name
curl --request PATCH \
  --url https://api.getfernand.com/organization/channels/{email} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Customer Support"
}
'
{
  "id": 12345,
  "name": "Support",
  "email": "support@piedpiper.com",
  "destination": "support@piedpiper.fernand-mails.com",
  "is_valid": true
}
Updates the display name of an existing channel identified by its email address. The email address itself cannot be changed.

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.

Path Parameters

​
email
string<email>
required

Email address of the channel to update.

Body

application/json
​
name
string
required

New display name for the channel.

Required string length: 3 - 50
Example:

"Customer Support"

Response

Channel updated 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