Create a brand link

Creates a new brand link.

post

Path parameters

domainIdstringRequired

The id of the domain.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

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

parentBrandLinkIdstring · nullableOptional

The parent brand link id. If this is null, it means the link is a node link.

codestring · nullableOptional

The code of the brand link.

namestring · min: 1Required

The name.

typestring · enumOptional

Provides all the types of BrandLink.

Possible values:

stylesstring · nullableOptional

The styles of the link.

iconUrlstring · uri · nullableOptional

The icon url.

linkstring · nullableOptional

The reference link. Clicking the link redirects to the specified URL. To use a local path, provide a relative path in the format: /path/to/your/page.

zOrderinteger · int32 · nullableOptional

The z-order numer of the link. If this is not provided, we will be checking the max z-order of the parent link and increment by 1.

statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

• Inactive - In case of JFW object's status being inactive.
• Active - In case of JFW object's status being active

Possible values:

descriptionstring · nullableOptional

The description.

Responses

201

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

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

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/domains/{domainId}/links

HTTPcURLJavaScriptPython

POST /api/v1/domains/{domainId}/links HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "parentBrandLinkId": "text",
  "code": "text",
  "name": "text",
  "type": "Unknown",
  "styles": "text",
  "iconUrl": "https://example.com",
  "link": "text",
  "zOrder": 1,
  "status": "Inactive",
  "description": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "brandId": "KAOplmx0i1A",
    "parentBrandLinkId": "Plo0szlmPs",
    "code": "SUPPORT",
    "name": "Name",
    "type": "BodyFooter",
    "styles": "Group Name",
    "iconURL": "https://www.example.com/icon.png",
    "link": "https://www.example.com",
    "description": "Description",
    "status": "Active",
    "items": [],
    "zOrder": 1,
    "id": "sApKpllz4sAplsmzha"
  },
  "errors": []
}