Update a promotional code

curl --request PUT \
  --url https://www.referly.so/api/v1/promotional-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "promotionalCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "active": true,
  "expiresAt": "2023-11-07T05:31:56Z",
  "maxRedemptions": 123,
  "firstTimeOrder": true,
  "minimumAmount": 123,
  "minimumAmountCurrency": "<string>",
  "limitToCustomers": true,
  "customerId": "<string>",
  "limitToAffiliate": true,
  "externalId": "<string>"
}
'

import requests

url = "https://www.referly.so/api/v1/promotional-codes"

payload = {
    "promotionalCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "code": "<string>",
    "active": True,
    "expiresAt": "2023-11-07T05:31:56Z",
    "maxRedemptions": 123,
    "firstTimeOrder": True,
    "minimumAmount": 123,
    "minimumAmountCurrency": "<string>",
    "limitToCustomers": True,
    "customerId": "<string>",
    "limitToAffiliate": True,
    "externalId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    promotionalCodeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    code: '<string>',
    active: true,
    expiresAt: '2023-11-07T05:31:56Z',
    maxRedemptions: 123,
    firstTimeOrder: true,
    minimumAmount: 123,
    minimumAmountCurrency: '<string>',
    limitToCustomers: true,
    customerId: '<string>',
    limitToAffiliate: true,
    externalId: '<string>'
  })
};

fetch('https://www.referly.so/api/v1/promotional-codes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.referly.so/api/v1/promotional-codes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'promotionalCodeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'code' => '<string>',
    'active' => true,
    'expiresAt' => '2023-11-07T05:31:56Z',
    'maxRedemptions' => 123,
    'firstTimeOrder' => true,
    'minimumAmount' => 123,
    'minimumAmountCurrency' => '<string>',
    'limitToCustomers' => true,
    'customerId' => '<string>',
    'limitToAffiliate' => true,
    'externalId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.referly.so/api/v1/promotional-codes"

	payload := strings.NewReader("{\n  \"promotionalCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"code\": \"<string>\",\n  \"active\": true,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"firstTimeOrder\": true,\n  \"minimumAmount\": 123,\n  \"minimumAmountCurrency\": \"<string>\",\n  \"limitToCustomers\": true,\n  \"customerId\": \"<string>\",\n  \"limitToAffiliate\": true,\n  \"externalId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://www.referly.so/api/v1/promotional-codes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"promotionalCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"code\": \"<string>\",\n  \"active\": true,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"firstTimeOrder\": true,\n  \"minimumAmount\": 123,\n  \"minimumAmountCurrency\": \"<string>\",\n  \"limitToCustomers\": true,\n  \"customerId\": \"<string>\",\n  \"limitToAffiliate\": true,\n  \"externalId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.referly.so/api/v1/promotional-codes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"promotionalCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"code\": \"<string>\",\n  \"active\": true,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"firstTimeOrder\": true,\n  \"minimumAmount\": 123,\n  \"minimumAmountCurrency\": \"<string>\",\n  \"limitToCustomers\": true,\n  \"customerId\": \"<string>\",\n  \"limitToAffiliate\": true,\n  \"externalId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "<string>",
  "active": true,
  "expiresAt": "2023-11-07T05:31:56Z",
  "maxRedemptions": 123,
  "timesRedeemed": 123,
  "firstTimeOrder": true,
  "minimumAmount": 123,
  "minimumAmountCurrency": "<string>",
  "limitToCustomers": true,
  "customerId": "<string>",
  "limitToAffiliate": true,
  "isAutoGenerated": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "coupon": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "externalId": "<string>",
    "percentOff": 123,
    "amountOff": 123,
    "currency": "<string>",
    "durationInMonths": 123,
    "maxRedemptions": 123,
    "timesRedeemed": 123,
    "limitToProducts": true,
    "productIds": [
      "<string>"
    ],
    "collectionIds": [
      "<string>"
    ],
    "valid": true,
    "redeemBy": "2023-11-07T05:31:56Z",
    "affiliateProgramId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "promotionalCodes": "<array>",
    "autoCouponRule": {}
  },
  "affiliate": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com"
  },
  "isAffiliateGenerated": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Promotional Code Endpoints

Update a Promotional Code

Updates a promotional code identified by promotionalCodeId, and fires the promotional_code.updated webhook.

Set active to false to switch a code off without deleting it — this is the safe way to retire a code an affiliate has already shared. Changing code renames it, and the new string must be unique within the program.

Every field you send is applied directly to the code, so sending a field that is not listed below will fail the request.

PUT

promotional-codes

Update a promotional code

curl --request PUT \
  --url https://www.referly.so/api/v1/promotional-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "promotionalCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "active": true,
  "expiresAt": "2023-11-07T05:31:56Z",
  "maxRedemptions": 123,
  "firstTimeOrder": true,
  "minimumAmount": 123,
  "minimumAmountCurrency": "<string>",
  "limitToCustomers": true,
  "customerId": "<string>",
  "limitToAffiliate": true,
  "externalId": "<string>"
}
'

import requests

url = "https://www.referly.so/api/v1/promotional-codes"

payload = {
    "promotionalCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "code": "<string>",
    "active": True,
    "expiresAt": "2023-11-07T05:31:56Z",
    "maxRedemptions": 123,
    "firstTimeOrder": True,
    "minimumAmount": 123,
    "minimumAmountCurrency": "<string>",
    "limitToCustomers": True,
    "customerId": "<string>",
    "limitToAffiliate": True,
    "externalId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    promotionalCodeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    code: '<string>',
    active: true,
    expiresAt: '2023-11-07T05:31:56Z',
    maxRedemptions: 123,
    firstTimeOrder: true,
    minimumAmount: 123,
    minimumAmountCurrency: '<string>',
    limitToCustomers: true,
    customerId: '<string>',
    limitToAffiliate: true,
    externalId: '<string>'
  })
};

fetch('https://www.referly.so/api/v1/promotional-codes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.referly.so/api/v1/promotional-codes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'promotionalCodeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'code' => '<string>',
    'active' => true,
    'expiresAt' => '2023-11-07T05:31:56Z',
    'maxRedemptions' => 123,
    'firstTimeOrder' => true,
    'minimumAmount' => 123,
    'minimumAmountCurrency' => '<string>',
    'limitToCustomers' => true,
    'customerId' => '<string>',
    'limitToAffiliate' => true,
    'externalId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.referly.so/api/v1/promotional-codes"

	payload := strings.NewReader("{\n  \"promotionalCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"code\": \"<string>\",\n  \"active\": true,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"firstTimeOrder\": true,\n  \"minimumAmount\": 123,\n  \"minimumAmountCurrency\": \"<string>\",\n  \"limitToCustomers\": true,\n  \"customerId\": \"<string>\",\n  \"limitToAffiliate\": true,\n  \"externalId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://www.referly.so/api/v1/promotional-codes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"promotionalCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"code\": \"<string>\",\n  \"active\": true,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"firstTimeOrder\": true,\n  \"minimumAmount\": 123,\n  \"minimumAmountCurrency\": \"<string>\",\n  \"limitToCustomers\": true,\n  \"customerId\": \"<string>\",\n  \"limitToAffiliate\": true,\n  \"externalId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.referly.so/api/v1/promotional-codes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"promotionalCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"code\": \"<string>\",\n  \"active\": true,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"firstTimeOrder\": true,\n  \"minimumAmount\": 123,\n  \"minimumAmountCurrency\": \"<string>\",\n  \"limitToCustomers\": true,\n  \"customerId\": \"<string>\",\n  \"limitToAffiliate\": true,\n  \"externalId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "<string>",
  "active": true,
  "expiresAt": "2023-11-07T05:31:56Z",
  "maxRedemptions": 123,
  "timesRedeemed": 123,
  "firstTimeOrder": true,
  "minimumAmount": 123,
  "minimumAmountCurrency": "<string>",
  "limitToCustomers": true,
  "customerId": "<string>",
  "limitToAffiliate": true,
  "isAutoGenerated": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "coupon": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "externalId": "<string>",
    "percentOff": 123,
    "amountOff": 123,
    "currency": "<string>",
    "durationInMonths": 123,
    "maxRedemptions": 123,
    "timesRedeemed": 123,
    "limitToProducts": true,
    "productIds": [
      "<string>"
    ],
    "collectionIds": [
      "<string>"
    ],
    "valid": true,
    "redeemBy": "2023-11-07T05:31:56Z",
    "affiliateProgramId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "promotionalCodes": "<array>",
    "autoCouponRule": {}
  },
  "affiliate": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com"
  },
  "isAffiliateGenerated": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Updating Promotional Codes

Update an existing promotional code’s properties. You can modify settings like activation status, expiration, and redemption limits.

Common Updates

Change the code string itself
Activate or deactivate a code
Update expiration dates
Modify redemption limits
Change affiliate assignment

You cannot change the parent coupon of a promotional code. If you need different discount terms, create a new promotional code with a different coupon.

Authorizations

Authorization

string

header

required

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

Body

application/json

Fields to update

promotionalCodeId

string<uuid>

required

The promotional code ID to update

code

string

Rename the code. Must be unique within the program.

active

boolean

Set to false to retire the code without deleting it

expiresAt

string<date-time>

Expiration date

maxRedemptions

integer

Maximum redemptions

firstTimeOrder

boolean

Limit to first-time orders

minimumAmount

number<float>

Minimum purchase amount

minimumAmountCurrency

string

Currency for minimum amount

limitToCustomers

boolean

Limit to specific customers

customerId

string

Specific customer ID

limitToAffiliate

boolean

Only affiliate can use

externalId

string

The code's ID in the connected billing provider

Response

The updated promotional code.

A code customers enter at checkout. Its discount comes from the coupon it belongs to.

string<uuid>

The promotional code ID

code

string

The actual promotional code string

couponId

string<uuid>

The parent coupon ID

affiliateId

string<uuid> | null

The affiliate ID this code is assigned to

externalId

string | null

External ID (e.g., Stripe promotion code ID)

active

boolean

Whether the promotional code is active

expiresAt

string<date-time> | null

Expiration date for the code

maxRedemptions

integer | null

How many times this code can be redeemed. null means unlimited. Redemptions are also capped by the parent coupon's own limit.

timesRedeemed

integer

Number of times this code has been redeemed

firstTimeOrder

boolean

Whether this code is limited to first-time orders

minimumAmount

number<float> | null

Minimum purchase amount required

minimumAmountCurrency

string | null

Currency for minimum amount

limitToCustomers

boolean

Whether code is limited to specific customers

customerId

string | null

Specific customer ID this code is limited to

limitToAffiliate

boolean

Whether only the assigned affiliate may redeem this code

isAutoGenerated

boolean

Whether this code was generated from a codeStructure rather than supplied by hand

createdAt

string<date-time>

Timestamp when the code was created

updatedAt

string<date-time>

Timestamp when the code was last updated

coupon

object

The coupon this code takes its discount from

Show child attributes

affiliate

object | null

Affiliate details

Show child attributes

isAffiliateGenerated

boolean

Whether the affiliate created this code themselves from their portal

Last modified on July 20, 2026

Delete a Promotional Code

API Documentation

Affiliate Endpoints

Referral Endpoints

Sale Endpoints

Affiliate Link Endpoints

Coupon Endpoints

Promotional Code Endpoints

Update a Promotional Code

Updating Promotional Codes

Common Updates

Authorizations

Body

Response

​Updating Promotional Codes

​Common Updates

Authorizations

Body

Response

Updating Promotional Codes

Common Updates