Skip to main content
POST
/
discount-codes
/
bulk-generate
Bulk generate discount codes
curl --request POST \
  --url https://api.sprucecollective.co.uk/discount-codes/bulk-generate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code_length": 18,
  "count": 5000,
  "discount_brand_id": "<string>",
  "points_required": 1,
  "title": "<string>",
  "active": true,
  "allow_multiple_claims": true,
  "alphanumeric": true,
  "category": "<string>",
  "description": "<string>",
  "discount_percentage": 50,
  "featured": true,
  "max_uses": 123,
  "partner_logo": "<string>",
  "partner_url": "<string>",
  "prefix": "<string>",
  "site_id": "<string>",
  "tag_ids": [
    "<string>"
  ],
  "terms": "<string>",
  "third_party_id": "<string>",
  "thumbnail": "<string>",
  "valid_from": "<string>",
  "valid_until": "<string>"
}
'
{}

Authorizations

Authorization
string
header
required

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

Body

application/json

Bulk generate discount codes

code_length
integer
required
Required range: 4 <= x <= 32
count
integer
required
Required range: 1 <= x <= 10000
discount_brand_id
string
required
points_required
integer
required
Required range: x >= 0
title
string
required
active
boolean
allow_multiple_claims
boolean
alphanumeric
boolean
category
string
description
string
discount_percentage
number

Removed required, 0.0 is valid

Required range: 0 <= x <= 100
max_uses
integer
partner_url
string
prefix
string
site_id
string
tag_ids
string[]

Array of tag IDs to associate

terms
string
third_party_id
string

Link to external system

thumbnail
string
valid_from
string
valid_until
string

Response

Created

The response is of type object.