APISettings
Update email address settings
Update an address's sender names, auto-reply, and forwarding behavior. Only the fields you send change. Requires the admin scope.
PATCH
/settings/email-addresses/{id}curl -X PATCH "https://productlane.com/api/v2/settings/email-addresses/{id}" \
-H "Authorization: Bearer $PRODUCTLANE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sender_name": "string",
"auto_reply_enabled": true,
"auto_reply_message": "string",
"is_broadcast_default": true,
"forwarded_email_handling": "AUTO"
}'Authorization
AuthorizationstringheaderrequiredBearer authentication header of the form
Bearer <token>, where<token>is your auth token.
Parameters
idstringpathrequired
Body
application/json
sender_namestring | nullauto_reply_enabledbooleanauto_reply_messagestringis_broadcast_defaultbooleanforwarded_email_handlingenum<string>One of:AUTOORIGINAL_SENDERFORWARDER
Response
application/json
Successful response
idstringrequiredemailstringrequireddomainstringrequiredinbound_addressstringrequiredsender_namestring | nullrequiredauto_reply_sender_namestring | nullrequiredis_enabledbooleanrequiredis_primarybooleanrequiredis_broadcast_defaultbooleanrequiredis_forwarding_setupbooleanrequiredauto_reply_enabledbooleanrequiredauto_reply_messagestringrequiredai_agent_enabledbooleanrequiredRead-only. True when the agent is enabled and its email channel is on. Set it under the agent settings, not per address.
forwarded_email_handlingstringrequiredOne of AUTO, ORIGINAL_SENDER, FORWARDER.
dns_txt_verifiedbooleanrequireddns_cname_verifiedbooleanrequiredcreated_atstringrequiredupdated_atstringrequired
{
"id": "string",
"email": "string",
"domain": "string",
"inbound_address": "string",
"sender_name": "string",
"auto_reply_sender_name": "string",
"is_enabled": true,
"is_primary": true,
"is_broadcast_default": true,
"is_forwarding_setup": true,
"auto_reply_enabled": true,
"auto_reply_message": "string",
"ai_agent_enabled": true,
"forwarded_email_handling": "string",
"dns_txt_verified": true,
"dns_cname_verified": true,
"created_at": "string",
"updated_at": "string"
}