Brand

Get brand details

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brand_idstringRequired

Responses

200Success

application/json

get

/brand/{brand_id}

HTTPcURLJavaScriptPython

GET /brand/{brand_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Update brand

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brand_idstringRequired

Body

application/json

brand_namestringOptional

brand_signaturestringOptional

brand_signature_namestringOptional

descriptionstringOptional

affiliation_program_urlstringOptional

sponsorsstring[]Optional

riddle_project_idstringOptional

riddle_leaderboard_idstringOptional

next_releasestringOptional

Responses

200Success

application/json

put

/brand/{brand_id}

HTTPcURLJavaScriptPython

PUT /brand/{brand_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1690

{
  "brand_name": "text",
  "brand_logo": {
    "light": "text",
    "dark": "text"
  },
  "brand_custom_login_page": {
    "mobile": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "desktop": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    }
  },
  "app": {
    "background": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    }
  },
  "brand_signature": "text",
  "brand_signature_name": "text",
  "favicon": {
    "light": "text",
    "dark": "text"
  },
  "description": "text",
  "description_banner": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "description_sub_icon": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "social_networks": [
    {
      "social_name": "facebook",
      "url": "text"
    }
  ],
  "colors": {
    "light": {
      "primary": "text",
      "secondary": "text",
      "tertiary": "text",
      "quaternary": "text",
      "bg_primary": "text",
      "bg_secondary": "text",
      "text_color": "text",
      "text_color_secondary": "text"
    },
    "dark": {
      "primary": "text",
      "secondary": "text",
      "tertiary": "text",
      "quaternary": "text",
      "bg_primary": "text",
      "bg_secondary": "text",
      "text_color": "text",
      "text_color_secondary": "text"
    }
  },
  "affiliation_program_url": "text",
  "sponsors": [
    "text"
  ],
  "riddle_project_id": "text",
  "riddle_leaderboard_id": "text",
  "unique_selling_points": [
    {
      "icon": "text",
      "icon_image": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "title": "text",
      "description": "text",
      "background": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      }
    }
  ],
  "claim_template": {
    "title": "text",
    "title_banner": "text",
    "sections": [
      {
        "type": "image_text",
        "asset": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "direction": "left",
        "title": "text",
        "description": "text",
        "icon": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        }
      }
    ]
  },
  "next_release": "text",
  "donation": [
    {
      "title": "text",
      "description": "text",
      "background": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "cta_label": "text",
      "external_url": "text"
    }
  ],
  "slugs": [
    "treebike"
  ]
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Delete brand

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brand_idstringRequired

Responses

200Success

application/json

delete

/brand/{brand_id}

HTTPcURLJavaScriptPython

DELETE /brand/{brand_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Create a new brand

post

Body

application/json

brand_namestringRequired

industrystringRequired

emailstringRequired

descriptionstringRequired

affiliation_program_urlstringRequired

Responses

200Success

application/json

post

/brand/create

HTTPcURLJavaScriptPython

POST /brand/create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 636

{
  "brand_name": "text",
  "industry": "text",
  "brand_logo": {
    "light": "text",
    "dark": "text"
  },
  "favicon": {
    "light": "text",
    "dark": "text"
  },
  "social_networks": [
    {
      "social_name": "facebook",
      "url": "text"
    }
  ],
  "email": "text",
  "description": "text",
  "colors": {
    "light": {
      "primary": "text",
      "secondary": "text",
      "tertiary": "text",
      "quaternary": "text",
      "bg_primary": "text",
      "bg_secondary": "text",
      "text_color": "text",
      "text_color_secondary": "text"
    },
    "dark": {
      "primary": "text",
      "secondary": "text",
      "tertiary": "text",
      "quaternary": "text",
      "bg_primary": "text",
      "bg_secondary": "text",
      "text_color": "text",
      "text_color_secondary": "text"
    }
  },
  "affiliation_program_url": "text",
  "slugs": [
    "treebike"
  ]
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Create a new brand with AI

post

Body

application/json

brand_urlstringRequired

Responses

200Success

application/json

post

/brand/create/ai

HTTPcURLJavaScriptPython

POST /brand/create/ai HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "brand_url": "text"
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Add a voucher

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

collection_idsstring[]Required

certificate_idsstring[]Required

voucher_imagestringRequired

voucher_titlestringRequired

voucher_descriptionstringRequired

voucher_promo_codestringRequired

expiration_datenumberRequired

custom_push_messagestringRequired

voucher_external_urlstringRequired

Responses

200Success

application/json

post

/brand/add/voucher

HTTPcURLJavaScriptPython

POST /brand/add/voucher HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "collection_ids": [
    "text"
  ],
  "certificate_ids": [
    "text"
  ],
  "voucher_image": "text",
  "voucher_title": "text",
  "voucher_description": "text",
  "voucher_promo_code": "text",
  "expiration_date": 1,
  "custom_push_message": "text",
  "voucher_external_url": "text"
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get vouchers

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brand_idstringRequired

Responses

200Success

application/json

get

/brand/coupons/{brand_id}

HTTPcURLJavaScriptPython

GET /brand/coupons/{brand_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Update a voucher

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

coupon_idstringRequired

Body

application/json

collection_idsstring[]Required

certificate_idsstring[]Required

voucher_imagestringRequired

voucher_titlestringRequired

voucher_descriptionstringRequired

voucher_promo_codestringRequired

expiration_datenumberRequired

custom_push_messagestringRequired

voucher_external_urlstringRequired

Responses

200Success

application/json

put

/brand/coupon/{coupon_id}

HTTPcURLJavaScriptPython

PUT /brand/coupon/{coupon_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "collection_ids": [
    "text"
  ],
  "certificate_ids": [
    "text"
  ],
  "voucher_image": "text",
  "voucher_title": "text",
  "voucher_description": "text",
  "voucher_promo_code": "text",
  "expiration_date": 1,
  "custom_push_message": "text",
  "voucher_external_url": "text"
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Delete a voucher

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

coupon_idstringRequired

Responses

200Success

application/json

delete

/brand/coupon/{coupon_id}

HTTPcURLJavaScriptPython

DELETE /brand/coupon/{coupon_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get brand products

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

get

/brand/product/all

HTTPcURLJavaScriptPython

GET /brand/product/all HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get product detail

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Responses

200Success

application/json

get

/brand/product/{product_id}

HTTPcURLJavaScriptPython

GET /brand/product/{product_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get associated artist

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

collection_idsstring[]Required

certificate_idsstring[]Required

voucher_imagestringRequired

voucher_titlestringRequired

voucher_descriptionstringRequired

voucher_promo_codestringRequired

expiration_datenumberRequired

custom_push_messagestringRequired

voucher_external_urlstringRequired

Responses

200Success

application/json

get

/brand/linked/arts

HTTPcURLJavaScriptPython

GET /brand/linked/arts HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "collection_ids": [
    "text"
  ],
  "certificate_ids": [
    "text"
  ],
  "voucher_image": "text",
  "voucher_title": "text",
  "voucher_description": "text",
  "voucher_promo_code": "text",
  "expiration_date": 1,
  "custom_push_message": "text",
  "voucher_external_url": "text"
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}