Update brand email settings

PUT

/v1/brands/{brandId}/email-settings

curl --request PUT \
  --url https://kynectlocal-production.up.railway.app/v1/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/email-settings \
  --header 'Authorization: Bearer <token>'

• Authenticated API (v1)
• Public API (no auth required)

Authorizations

• BearerAuth

Parameters

Path Parameters

brandId

required

string format: uuid

Brand identifier

Responses

200

Success

Media type application/json

object

data

required

object

emailNotificationEnabled

required

Whether notification emails are enabled

boolean | null

emailNotificationSubject

required

Notification email subject template

string | null

emailNotificationBody

required

Notification email body (HTML/TipTap)

string | null

emailNotificationReplyTo

required

Reply-to address for notification emails

string | null

emailAutoresponderEnabled

required

Whether autoresponder emails are enabled

boolean | null

emailAutoresponderSubject

required

Autoresponder subject template

string | null

emailAutoresponderBody

required

Autoresponder body (HTML/TipTap)

string | null

emailLockAutoresponder

required

Whether autoresponder settings are locked for franchisees

boolean | null

emailLockNotification

required

Whether notification settings are locked for franchisees

boolean | null

isConfigured

required

Whether the email provider is configured

boolean

defaultNotificationSubject

required

System default notification subject

string

defaultNotificationBody

required

System default notification body

string

defaultAutoresponderSubject

required

System default autoresponder subject

string

defaultAutoresponderBody

required

System default autoresponder body

string

Example ^generated

{
  "data": {
    "emailNotificationEnabled": true,
    "emailNotificationSubject": "example",
    "emailNotificationBody": "example",
    "emailNotificationReplyTo": "example",
    "emailAutoresponderEnabled": true,
    "emailAutoresponderSubject": "example",
    "emailAutoresponderBody": "example",
    "emailLockAutoresponder": true,
    "emailLockNotification": true,
    "isConfigured": true,
    "defaultNotificationSubject": "example",
    "defaultNotificationBody": "example",
    "defaultAutoresponderSubject": "example",
    "defaultAutoresponderBody": "example"
  }
}

400

Validation error

Media type application/json

object

error

required

Error envelope

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

details

Additional context, e.g. validation field errors

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

Error envelope

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

details

Additional context, e.g. validation field errors

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

Error envelope

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

details

Additional context, e.g. validation field errors

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media type application/json

object

error

required

Error envelope

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

details

Additional context, e.g. validation field errors

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Unprocessable

Media type application/json

object

error

required

Error envelope

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

details

Additional context, e.g. validation field errors

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}