Create an email address

Create an email address by brand

post

Path parameters

brandIdstringRequired

The id of the brand.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Body

application/jsontext/jsonapplication/*+json

This class is used to create, update for the brand email address.

placeholderKeyTitlestring | nullableOptional

The placeholder key of the title, that value relate with email template.

titlestring · min: 1Required

The title of the email address.

placeholderKeyEmailAddressstring | nullableOptional

The placeholder key of the email address, that value relate with email template.

emailAddressstring · email · min: 1Required

The email address value.

descriptionstring | nullableOptional

The description.

Responses

201

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/brands/{brandId}/email-addresses HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "placeholderKeyTitle": "text",
  "title": "text",
  "placeholderKeyEmailAddress": "text",
  "emailAddress": "[e-mail]",
  "description": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "placeholderKeyTitle": "support_title",
    "title": "Suport",
    "placeholderKeyEmailAddress": "support_email",
    "emailAddress": "[e-mail]",
    "description": "Support email of the brand",
    "id": "sApKpllz4sAplsmzha",
    "createdDate": "2025-06-12T14:59:17.023119+07:00"
  },
  "errors": []
}