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.
smtp.host	string	No	SMTP server hostname.
smtp.port	integer	No	SMTP port (e.g. 587 for STARTTLS, 465 for implicit TLS).
smtp.user	string	No	SMTP username.
smtp.password	string	No	SMTP password. Write-only — never returned in GET responses.
smtp.from	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",
  "smtp": { "host": "smtp.acme.com", "port": 587, "user": "noreply@acme.com", "hasPassword": true, "from": "noreply@acme.com" },
  "updatedAt": "2026-06-09T10:00:00Z"
}

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>"

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

Partner Settings

Get / update settings

Send an SMTP test email

On this page