API product catalogDeveloper Platform, Sandbox & Key Management

Update settings

Developer Platform, Sandbox & Key Management

PATCH

/settings

Update settings

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.

Request reference

Sandbox available

Use the API Tester for write requests, including request bodies and idempotency keys.

https://mystocks.africa/api/sandbox/v1/partner/settings

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Settings updated."
    }
  }
}

curl -X PATCH 'https://mystocks.africa/api/sandbox/v1/partner/settings' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "logoUrl": "https://yourcompany.com/logo.png"
}'

GET /settings

POST /settings