Create a feature

Creates a new feature.

post

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

application/jsontext/jsonapplication/*+json

This class represents the feature data transfer object for the command request.

eventIdstring · min: 1Required

The event id. This value represents the event that the feature belongs to.

typestring · enumOptionalPossible values:

codestring · min: 1Required

The code of the feature.

namestring · min: 1Required

The name of the feature.

imagestring · uri | nullableOptional

The image of the feature. This value must be a valid URL.

stylesstring | nullableOptional

The style of the feature. It is a JSON string. You can use this property to store the CSS styles of the feature.

descriptionstring | nullableOptional

The description of the feature. The description can be a long text.

tagsstring | nullableOptional

The tags of the feature. You can use this property to store the tags of the feature.

zOrderinteger · int64Optional

The order number in the list. This property is used to sort the features in the list when displaying them. By default, the value is 1.

statusstring · enumOptionalPossible values:

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 AuthKey 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/features HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "eventId": "text",
  "type": "0 - Function",
  "code": "text",
  "name": "text",
  "image": "https://example.com",
  "styles": "text",
  "description": "text",
  "tags": "text",
  "zOrder": 1,
  "status": "0 - Inactive"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "parentBrandId": "ParentBrandId",
    "eventId": "TrackingEventId",
    "type": "Function",
    "code": "Code",
    "name": "Name",
    "image": "https://www.example.com/image.jpg",
    "styles": "{\"color\": \"red\"}",
    "description": "Description",
    "tags": "Tag1, Tag2",
    "zOrder": 1,
    "status": "Active",
    "id": "sApKpllz4sAplsmzha"
  },
  "errors": []
}