Update a email

PreviousUpdate a brand's setting NextCDN

Last updated 2 months ago

Was this helpful?

Updates the brand's emails by the given brand id.

put

Path parameters

idstringRequired

The id of the brand.

Query parameters

api-versionstringOptional

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

supportEmailstring · email | nullableOptional

The support email of the Brand.

supportTitleEmailstring | nullableOptional

The support title email of the Brand.

systemEmailstring · email | nullableOptional

The system email of the Brand.

systemTitleEmailstring | nullableOptional

The system title email of the Brand.

loginNotificationEmailstring · email | nullableOptional

The login notification email of the Brand.

purchaseNotificationEmailstring · email | nullableOptional

The purchase notification email of the Brand.

orderNotificationEmailstring · email | nullableOptional

The order notification email of the Brand.

chargebackNotificationEmailstring · email | nullableOptional

The chargeback notification email of the Brand.

refundNotificationEmailstring · email | nullableOptional

The refund notification email of the Brand.

loginNotificationTitleEmailstring | nullableOptional

The login notification title email of the Brand.

maintenanceTeamEmailstring · email | nullableOptional

The maintenance team email of the Brand.

developerTeamEmailstring · email | nullableOptional

The developer team email of the Brand.

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required AuthKey header.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

put

PUT /api/v1/brands/{id}/emails HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Content-Type: application/json
Accept: */*
Content-Length: 451

{
  "supportEmail": "name@gmail.com",
  "supportTitleEmail": "text",
  "systemEmail": "name@gmail.com",
  "systemTitleEmail": "text",
  "loginNotificationEmail": "name@gmail.com",
  "purchaseNotificationEmail": "name@gmail.com",
  "orderNotificationEmail": "name@gmail.com",
  "chargebackNotificationEmail": "name@gmail.com",
  "refundNotificationEmail": "name@gmail.com",
  "loginNotificationTitleEmail": "text",
  "maintenanceTeamEmail": "name@gmail.com",
  "developerTeamEmail": "name@gmail.com"
}

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "supportEmail": "support@example.com",
    "supportTitleEmail": "Support",
    "systemEmail": "system@example.com",
    "systemTitleEmail": "System",
    "loginNotificationEmail": "notification@example.com",
    "purchaseNotificationEmail": "purchase@example.com",
    "orderNotificationEmail": "order@example.com",
    "chargebackNotificationEmail": "chargeback@example.com",
    "refundNotificationEmail": "refund@example.com",
    "loginNotificationTitleEmail": "Login Notification",
    "maintenanceTeamEmail": "maintenance@example.com",
    "developerTeamEmail": "devteam@example.com",
    "id": "sApKpllz4sAplsmzha"
  },
  "errors": []
}