curl -X PUT "https://api.usegately.com/api/v1/settings" \
-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"
}'
curl -X PUT "https://api.usegately.com/api/v1/settings" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"primary_color": "#3b82f6",
"logo_url": "https://cdn.magana.com/logo.png",
"support_email": "help@magana.com"
}'
await gately.settings.update({
sender_name: 'Magana Team',
sender_email: 'hello@magana.com',
reply_to_email: 'support@magana.com',
})
{
"success": true,
"data": {
"sender_name": "Magana Team",
"sender_email": "hello@magana.com",
"reply_to_email": "support@magana.com",
"primary_color": "#FE551B",
"allow_new_member_signup": true,
"session_duration_days": 30
}
}
{
"error": "Unauthorized",
"code": "UNAUTHORIZED"
}
Project Settings
Update Settings
Update project settings including the email sender name, sender address, branding, and authentication configuration
PUT
/
api
/
v1
/
settings
curl -X PUT "https://api.usegately.com/api/v1/settings" \
-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"
}'
curl -X PUT "https://api.usegately.com/api/v1/settings" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"primary_color": "#3b82f6",
"logo_url": "https://cdn.magana.com/logo.png",
"support_email": "help@magana.com"
}'
await gately.settings.update({
sender_name: 'Magana Team',
sender_email: 'hello@magana.com',
reply_to_email: 'support@magana.com',
})
{
"success": true,
"data": {
"sender_name": "Magana Team",
"sender_email": "hello@magana.com",
"reply_to_email": "support@magana.com",
"primary_color": "#FE551B",
"allow_new_member_signup": true,
"session_duration_days": 30
}
}
{
"error": "Unauthorized",
"code": "UNAUTHORIZED"
}
Updates any combination of project settings. Only fields you include in the request body are changed — all others remain untouched.
Changes to
sender_name and sender_email take effect immediately on the next email sent from your project — including magic links, password resets, member invitations, and campaigns.Headers
string
required
Bearer YOUR_API_KEYRequest Body
All fields are optional. Include only the fields you want to change.string
Display name shown in the From field of all outgoing emails.Example:
"Magana Team" → recipients see From: Magana Teamstring
Email address used as the From address for all emails.If you have a verified sending domain, this is used directly. Otherwise it is used as the Reply-To and emails send from
hello@usegately.com.Example: "hello@magana.com"string
Explicit Reply-To address. Defaults to
sender_email if not set.string
Support contact email shown in transactional email footers.
string
Brand hex color used in transactional email templates (e.g.
"#FE551B").string
Full URL to your logo — shown in transactional email headers.
boolean
Set
false to prevent new members from registering.boolean
Allow unauthenticated access to member content pages.
number
How long member sessions stay active before requiring re-login. Default:
30.boolean
Require members to choose a paid plan during signup.
boolean
Enable a custom email footer (available on paid plans).
string
Custom footer text appended to all outgoing campaign emails. Supports newlines.
Response
Returns the updated settings object.curl -X PUT "https://api.usegately.com/api/v1/settings" \
-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"
}'
curl -X PUT "https://api.usegately.com/api/v1/settings" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"primary_color": "#3b82f6",
"logo_url": "https://cdn.magana.com/logo.png",
"support_email": "help@magana.com"
}'
await gately.settings.update({
sender_name: 'Magana Team',
sender_email: 'hello@magana.com',
reply_to_email: 'support@magana.com',
})
{
"success": true,
"data": {
"sender_name": "Magana Team",
"sender_email": "hello@magana.com",
"reply_to_email": "support@magana.com",
"primary_color": "#FE551B",
"allow_new_member_signup": true,
"session_duration_days": 30
}
}
{
"error": "Unauthorized",
"code": "UNAUTHORIZED"
}
Was this page helpful?