Skip to content
MyStocks Developers
API v1

API v1

Current stable contract

Versioning policyRelease changelog
Sandbox console
Reference

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

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

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

/settings

Update settings

Full endpoint documentation
Sandbox availableupdateSettings

Updates partner configuration. All fields are optional — only provided fields are changed. Set emailConfig to null to revert to MyStocks default transactional emails.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Idempotency-KeystringheaderRequired

Unique string that makes write calls safe to retry on network failure. Required for money movement, trading, KYC, subscriptions, and webhook creation. Deduplicated for 24 hours -- duplicate keys return the cached response. HTTP 409 if a concurrent request with the same key is still in progress.

Example: dep_user42_1743152580

Request body

logoUrlstring | null

HTTPS URL of your company logo. Shown in partner-branded emails.

Example: "https://cdn.yourapp.com/logo.png"

emailConfigobject | null

Custom SMTP config. Set to null to revert to MyStocks default emails.

emailConfig.hoststring

SMTP hostname. e.g. smtp.sendgrid.net, smtp.gmail.com.

Example: "smtp.sendgrid.net"

emailConfig.portinteger

SMTP port. Default 587 (STARTTLS). Use 465 for implicit TLS.

Example: 587

emailConfig.secureboolean

true = implicit TLS (port 465). false = STARTTLS (port 587).

Example: false

emailConfig.usernamestring

SMTP auth username.

Example: "apikey"

emailConfig.passwordstring

SMTP password or API key. Omit to keep existing.

emailConfig.fromNamestring

Display name in the From header.

Example: "Acme Investments"

emailConfig.fromEmailstring

From email address.

Example: "noreply@acme.com"

Response fields

messagestring

Example: "Settings updated."

Response codes

200Settings updated.

Send an SMTP test email

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.

POST

/settings

Test SMTP

Full endpoint documentation
Sandbox availablecreateSettings

Sends a test email via your saved custom SMTP configuration to the authenticated partner account email. Use this to verify that your email settings are correct before going live. This operation does not accept a request body.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Idempotency-KeystringheaderRequired

Unique string that makes write calls safe to retry on network failure. Required for money movement, trading, KYC, subscriptions, and webhook creation. Deduplicated for 24 hours -- duplicate keys return the cached response. HTTP 409 if a concurrent request with the same key is still in progress.

Example: dep_user42_1743152580

Response fields

messagestring

Example: "Test email sent to dev@acme.com"

Response codes

200SMTP test result.

Was this page useful?

Your signal helps us tighten partner onboarding docs.

Send note

Last updated on

Previous

POST /webhooks/{id}/test

Next

Errors

On this page