Skip to main content
POST
/
discount-brands
Create discount brand
curl --request POST \
  --url https://api.sprucecollective.co.uk/discount-brands \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "archived": true,
  "collection_id": "<string>",
  "description": "<string>",
  "draft": true,
  "item_id": "<string>",
  "locale_id": "<string>",
  "logo": "<string>",
  "logo_black_and_white": "<string>",
  "max_discount": "<string>",
  "site_id": "<string>",
  "thumbnail": "<string>"
}
'
{
  "archived": true,
  "collection_id": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "discount_codes": [
    {
      "active": true,
      "allow_multiple_claims": true,
      "alphanumeric": true,
      "category": "<string>",
      "claimed_codes": [
        "<string>"
      ],
      "code": "<string>",
      "code_display": "<string>",
      "code_length": 123,
      "code_pattern": "<string>",
      "code_required": true,
      "created_at": "<string>",
      "current_uses": 123,
      "description": "<string>",
      "discount_brand": "<unknown>",
      "discount_brand_id": "<string>",
      "discount_percentage": 123,
      "featured": true,
      "has_claimed_code": true,
      "id": "<string>",
      "is_bulk_code": true,
      "is_valid": true,
      "max_uses": 123,
      "partner_logo": "<string>",
      "partner_url": "<string>",
      "points_required": 123,
      "site_id": "<string>",
      "tags": [
        {
          "active": true,
          "color": "<string>",
          "created_at": "<string>",
          "description": "<string>",
          "id": "<string>",
          "name": "<string>",
          "site_id": "<string>",
          "slug": "<string>",
          "updated_at": "<string>"
        }
      ],
      "terms": "<string>",
      "third_party_id": "<string>",
      "thumbnail": "<string>",
      "title": "<string>",
      "updated_at": "<string>",
      "valid_from": "<string>",
      "valid_until": "<string>"
    }
  ],
  "draft": true,
  "id": "<string>",
  "item_id": "<string>",
  "locale_id": "<string>",
  "logo": "<string>",
  "logo_black_and_white": "<string>",
  "max_discount": "<string>",
  "name": "<string>",
  "published_on": "<string>",
  "site_id": "<string>",
  "slug": "<string>",
  "thumbnail": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and JWT token.

Body

application/json

Discount brand data

name
string
required
slug
string
required
archived
boolean
collection_id
string
description
string
draft
boolean
item_id
string
locale_id
string
logo_black_and_white
string
max_discount
string
site_id
string
thumbnail
string

Response

Created

archived
boolean
collection_id
string
created_at
string
description
string
discount_codes
object[]
draft
boolean
id
string
item_id
string
locale_id
string
logo_black_and_white
string
max_discount
string
name
string
published_on
string
site_id
string
slug
string
thumbnail
string
updated_at
string