Partner Settings

Configure partner branding (logo URL) and SMTP transactional email for partner-branded messages to your sub-account users. Every change logs a settings.updated audit event.

Configure branding (logo URL) and SMTP transactional email. SMTP enables partner-branded emails to your sub-account users. A settings.updated audit event is logged on every PATCH with the list of changed fields.

Get / update settings

GET PATCH /settings

Fetch or update partner settings. The SMTP password is never returned — only a hasPassword: true boolean confirms it is set.

Field	Type	Required	Description
logoUrl	string	No	HTTPS URL to your company logo (PNG or SVG). Shown in the dashboard and partner-branded emails.
emailConfig.host	string	No	SMTP server hostname.
emailConfig.port	integer	No	SMTP port (e.g. 587 for STARTTLS, 465 for implicit TLS).
emailConfig.secure	boolean	No	true for implicit TLS; false for STARTTLS.
emailConfig.username	string	No	SMTP authentication username.
emailConfig.password	string	No	SMTP password. Write-only — never returned in GET responses.
emailConfig.fromName	string	No	Display name in the From header.
emailConfig.fromEmail	string	No	From address for outbound emails, e.g. noreply@acme.com.

curl "https://mystocks.africa/api/v1/partner/settings" \
  -H "Authorization: Bearer pk_live_<key>"

{
  "logoUrl": "https://acme.com/logo.svg",
  "emailConfig": { "host": "smtp.acme.com", "port": 587, "secure": false, "username": "noreply@acme.com", "fromName": "Acme Investments", "fromEmail": "noreply@acme.com", "hasPassword": true }
}

Send an SMTP test email

POST /settings (SMTP test)

Send a test email via your configured SMTP server to your registered partner address. Use it to validate SMTP credentials before enabling partner-branded emails.

curl -X POST "https://mystocks.africa/api/v1/partner/settings" \
  -H "Authorization: Bearer pk_live_<key>" \
  -H "Idempotency-Key: smtp-test-2026-08-10"

{ "message": "Test email sent to dev@acme.com" }

Partner Settings

Get / update settings

Send an SMTP test email

On this page