API documentation

Update Brand Email Settings

put/api/v1/Brands/{brandId}/email-settings

Set the brand's email overrides. Empty/null fields clear the override (revert to default).

Brands

Parameters

brandId

path · string

Required

version

path · string

Required

Request body

{
  "fromName": "Alex Morgan",
  "fromAddress": "Example",
  "adminEmail": "alex@example.com",
  "paymentsEmail": "alex@example.com",
  "htmlHeader": "Example",
  "htmlFooter": "Example"
}

Responses

The OpenAPI specification does not include response body schemas for this endpoint. Use Try It with your credentials to see a live response.

200Success

Language

Auth

Credentials

Authorization: Bearer

Create a personal access token in the signed-in app under Developers, then paste it here. Prefer this path for your own scripts.

Request inputs

brandIdpath

Required

Request body

Required

Request

curl --request PUT \
  --url https://platform.obermind.com/api/v1/Brands/{brandId}/email-settings \
  --header 'content-type: application/json' \
  --data '{
  "fromName": "Alex Morgan",
  "fromAddress": "Example",
  "adminEmail": "alex@example.com",
  "paymentsEmail": "alex@example.com",
  "htmlHeader": "Example",
  "htmlFooter": "Example"
}'

Response

Click Try It! to start a request and see the response here.

Launch Your Platform.

Get Started.Try it out.