curl "https://api.usegately.com/api/v1/settings/email" \
-H "Authorization: Bearer YOUR_API_KEY"
curl -X PUT "https://api.usegately.com/api/v1/settings/email" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sender_name": "Magana Team",
"sender_email": "hello@magana.com",
"reply_to_email": "support@magana.com"
}'
// Get
const email = await gately.settings.getEmail()
// Update
await gately.settings.updateEmail({
sender_name: 'Magana Team',
sender_email: 'hello@magana.com',
reply_to_email: 'support@magana.com',
})
{
"success": true,
"data": {
"sender_email": "hello@magana.com",
"sender_name": "Magana Team",
"reply_to_email": "support@magana.com"
}
}
{
"success": true,
"data": {
"sender_email": "hello@magana.com",
"sender_name": "Magana Team",
"reply_to_email": "support@magana.com"
}
}
Project Settings
Email Sender Settings
Get or update the email sender name and address used for all transactional and campaign emails
PUT
/
api
/
v1
/
settings
/
email
curl "https://api.usegately.com/api/v1/settings/email" \
-H "Authorization: Bearer YOUR_API_KEY"
curl -X PUT "https://api.usegately.com/api/v1/settings/email" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sender_name": "Magana Team",
"sender_email": "hello@magana.com",
"reply_to_email": "support@magana.com"
}'
// Get
const email = await gately.settings.getEmail()
// Update
await gately.settings.updateEmail({
sender_name: 'Magana Team',
sender_email: 'hello@magana.com',
reply_to_email: 'support@magana.com',
})
{
"success": true,
"data": {
"sender_email": "hello@magana.com",
"sender_name": "Magana Team",
"reply_to_email": "support@magana.com"
}
}
{
"success": true,
"data": {
"sender_email": "hello@magana.com",
"sender_name": "Magana Team",
"reply_to_email": "support@magana.com"
}
}
Controls the From name and email address shown to recipients on every email your project sends — magic links, password resets, member invitations, and campaigns.
How sender resolution works
- If
sender_emailis set and you have a verified sending domain, emails send fromsender_name <sender_email>directly. - If
sender_emailis set but no verified domain, the sender name is applied andsender_emailis used as the Reply-To. - If neither is set, emails fall back to
Gately <hello@usegately.com>.
GET /settings/email
Retrieve current email sender configuration.Headers
string
required
Bearer YOUR_API_KEYResponse
string | null
Configured From email address
string | null
Configured From display name
string | null
Configured Reply-To address
PUT /settings/email
Update email sender configuration.Request Body
string
required
Display name shown in the From field (e.g.
"Magana Team")string
required
Email address for the From field (e.g.
"hello@magana.com")string
Reply-To address. If omitted, defaults to
sender_email.curl "https://api.usegately.com/api/v1/settings/email" \
-H "Authorization: Bearer YOUR_API_KEY"
curl -X PUT "https://api.usegately.com/api/v1/settings/email" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sender_name": "Magana Team",
"sender_email": "hello@magana.com",
"reply_to_email": "support@magana.com"
}'
// Get
const email = await gately.settings.getEmail()
// Update
await gately.settings.updateEmail({
sender_name: 'Magana Team',
sender_email: 'hello@magana.com',
reply_to_email: 'support@magana.com',
})
{
"success": true,
"data": {
"sender_email": "hello@magana.com",
"sender_name": "Magana Team",
"reply_to_email": "support@magana.com"
}
}
{
"success": true,
"data": {
"sender_email": "hello@magana.com",
"sender_name": "Magana Team",
"reply_to_email": "support@magana.com"
}
}
Was this page helpful?