Skip to main content
POST
/
campaigns
/
{campaign}
/
discount-codes
cURL
curl --request POST \
  --url https://api.givebutter.com/v1/campaigns/{campaign}/discount-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "percentage",
  "active": true,
  "amount": 2,
  "code": "<string>",
  "items": [
    "<string>"
  ],
  "uses": 2,
  "starts_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": 123,
  "campaign_id": 123,
  "code": "<string>",
  "type": "<string>",
  "amount": 123,
  "used": 123,
  "uses": 123,
  "active": true,
  "total_discount": "<string>",
  "starts_at": "<string>",
  "expires_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "items": [
    "<unknown>"
  ],
  "all_items": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign
integer
required

The campaign ID

Body

application/json
type
enum<string>
required
Available options:
percentage,
fixed
active
boolean
required
amount
number
required
Required range: x >= 1
code
string
required
Maximum string length: 255
items
string[] | null
uses
number | null
Required range: x >= 1
starts_at
string<date-time> | null
expires_at
string<date-time> | null

Response

CampaignDiscountCodeResource

id
integer
required
campaign_id
integer
required
code
string
required
type
string
required
amount
number
required
used
integer
required
uses
integer | null
required
active
boolean
required
total_discount
string
required
starts_at
string
required
expires_at
string
required
created_at
string
required
updated_at
string
required
items
any[]
all_items
boolean