Update reward

PATCH

rewards

{id}

Update reward

curl --request PATCH \
  --url https://api.oneofnone.io/v1/rewards/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "value": 50000000,
  "minimumPurchase": 1,
  "minimumQuantity": 1,
  "usageLimitTotal": 1,
  "usageLimitPerCustomer": 1,
  "startsAt": "<string>",
  "expiresAt": "<string>",
  "stackable": true,
  "globalCode": "<string>",
  "externalUrl": "<string>",
  "imageId": 123,
  "conditions": {}
}
'

import requests

url = "https://api.oneofnone.io/v1/rewards/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "value": 50000000,
    "minimumPurchase": 1,
    "minimumQuantity": 1,
    "usageLimitTotal": 1,
    "usageLimitPerCustomer": 1,
    "startsAt": "<string>",
    "expiresAt": "<string>",
    "stackable": True,
    "globalCode": "<string>",
    "externalUrl": "<string>",
    "imageId": 123,
    "conditions": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    value: 50000000,
    minimumPurchase: 1,
    minimumQuantity: 1,
    usageLimitTotal: 1,
    usageLimitPerCustomer: 1,
    startsAt: '<string>',
    expiresAt: '<string>',
    stackable: true,
    globalCode: '<string>',
    externalUrl: '<string>',
    imageId: 123,
    conditions: {}
  })
};

fetch('https://api.oneofnone.io/v1/rewards/{id}', 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://api.oneofnone.io/v1/rewards/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'value' => 50000000,
    'minimumPurchase' => 1,
    'minimumQuantity' => 1,
    'usageLimitTotal' => 1,
    'usageLimitPerCustomer' => 1,
    'startsAt' => '<string>',
    'expiresAt' => '<string>',
    'stackable' => true,
    'globalCode' => '<string>',
    'externalUrl' => '<string>',
    'imageId' => 123,
    'conditions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://api.oneofnone.io/v1/rewards/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"value\": 50000000,\n  \"minimumPurchase\": 1,\n  \"minimumQuantity\": 1,\n  \"usageLimitTotal\": 1,\n  \"usageLimitPerCustomer\": 1,\n  \"startsAt\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"stackable\": true,\n  \"globalCode\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"imageId\": 123,\n  \"conditions\": {}\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.patch("https://api.oneofnone.io/v1/rewards/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"value\": 50000000,\n  \"minimumPurchase\": 1,\n  \"minimumQuantity\": 1,\n  \"usageLimitTotal\": 1,\n  \"usageLimitPerCustomer\": 1,\n  \"startsAt\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"stackable\": true,\n  \"globalCode\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"imageId\": 123,\n  \"conditions\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.oneofnone.io/v1/rewards/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"value\": 50000000,\n  \"minimumPurchase\": 1,\n  \"minimumQuantity\": 1,\n  \"usageLimitTotal\": 1,\n  \"usageLimitPerCustomer\": 1,\n  \"startsAt\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"stackable\": true,\n  \"globalCode\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"imageId\": 123,\n  \"conditions\": {}\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "value": 123,
  "minimumPurchase": 123,
  "minimumQuantity": 123,
  "usageLimitTotal": 123,
  "usageLimitPerCustomer": 123,
  "startsAt": "<string>",
  "expiresAt": "<string>",
  "stackable": true,
  "globalCode": "<string>",
  "externalUrl": "<string>",
  "imageId": 123,
  "conditions": {},
  "totalRedemptions": 123,
  "totalRevenueImpact": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "image": {
    "id": 123,
    "url": "<string>"
  },
  "externalIds": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rewardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "externalCodeId": "<string>",
      "syncedAt": "<string>",
      "error": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "access": {
    "qualifies": true,
    "reasons": [
      "<string>"
    ]
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

Authorizations

x-api-key

string

header

required

Path Parameters

string<uuid>

required

Body

application/json

name

string

Required string length: 1 - 500

description

string | null

Maximum string length: 5000

type

enum<string>

Available options:

DISCOUNT,

GATED_CONTENT,

FREE_CLAIM,

EARLY_ACCESS,

CREDIT

scope

enum<string>

Available options:

sitewide,

collection,

product,

variant

valueType

enum<string>

Available options:

percentage,

fixed_amount,

free_shipping,

gated_content

value

integer

Required range: 0 <= x <= 100000000

minimumPurchase

integer | null

Required range: x >= 0

minimumQuantity

integer | null

Required range: x >= 0

usageLimitTotal

integer | null

Required range: x >= 0

usageLimitPerCustomer

integer | null

Required range: x >= 0

startsAt

string

expiresAt

string | null

stackable

boolean

codeType

enum<string>

Available options:

automatic,

global_code,

unique_codes

globalCode

string | null

Required string length: 1 - 64

externalUrl

string<uri> | null

imageId

integer | null

conditions

object

Show child attributes

status

enum<string>

Available options:

draft,

active,

paused,

expired,

archived

Response

Successful response

string<uuid>

required

teamId

string<uuid>

required

name

string

required

description

string | null

required

type

enum<string>

required

Available options:

DISCOUNT,

GATED_CONTENT,

FREE_CLAIM,

EARLY_ACCESS,

CREDIT

scope

enum<string>

required

Available options:

sitewide,

collection,

product,

variant

valueType

enum<string>

required

Available options:

percentage,

fixed_amount,

free_shipping,

gated_content

value

integer

required

minimumPurchase

integer | null

required

minimumQuantity

integer | null

required

usageLimitTotal

integer | null

required

usageLimitPerCustomer

integer | null

required

startsAt

string

required

expiresAt

string | null

required

stackable

boolean

required

codeType

enum<string>

required

Available options:

automatic,

global_code,

unique_codes

globalCode

string | null

required

externalUrl

string | null

required

imageId

integer | null

required

conditions

object

required

Show child attributes

status

enum<string>

required

Available options:

draft,

active,

paused,

expired,

archived

totalRedemptions

integer

required

totalRevenueImpact

number

required

createdAt

string

required

updatedAt

string | null

required

image

object | null

Show child attributes

externalIds

object[]

Show child attributes

access

object

Show child attributes

Archive reward

Update reward

curl --request PATCH \
  --url https://api.oneofnone.io/v1/rewards/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "value": 50000000,
  "minimumPurchase": 1,
  "minimumQuantity": 1,
  "usageLimitTotal": 1,
  "usageLimitPerCustomer": 1,
  "startsAt": "<string>",
  "expiresAt": "<string>",
  "stackable": true,
  "globalCode": "<string>",
  "externalUrl": "<string>",
  "imageId": 123,
  "conditions": {}
}
'

import requests

url = "https://api.oneofnone.io/v1/rewards/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "value": 50000000,
    "minimumPurchase": 1,
    "minimumQuantity": 1,
    "usageLimitTotal": 1,
    "usageLimitPerCustomer": 1,
    "startsAt": "<string>",
    "expiresAt": "<string>",
    "stackable": True,
    "globalCode": "<string>",
    "externalUrl": "<string>",
    "imageId": 123,
    "conditions": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    value: 50000000,
    minimumPurchase: 1,
    minimumQuantity: 1,
    usageLimitTotal: 1,
    usageLimitPerCustomer: 1,
    startsAt: '<string>',
    expiresAt: '<string>',
    stackable: true,
    globalCode: '<string>',
    externalUrl: '<string>',
    imageId: 123,
    conditions: {}
  })
};

fetch('https://api.oneofnone.io/v1/rewards/{id}', 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://api.oneofnone.io/v1/rewards/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'value' => 50000000,
    'minimumPurchase' => 1,
    'minimumQuantity' => 1,
    'usageLimitTotal' => 1,
    'usageLimitPerCustomer' => 1,
    'startsAt' => '<string>',
    'expiresAt' => '<string>',
    'stackable' => true,
    'globalCode' => '<string>',
    'externalUrl' => '<string>',
    'imageId' => 123,
    'conditions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://api.oneofnone.io/v1/rewards/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"value\": 50000000,\n  \"minimumPurchase\": 1,\n  \"minimumQuantity\": 1,\n  \"usageLimitTotal\": 1,\n  \"usageLimitPerCustomer\": 1,\n  \"startsAt\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"stackable\": true,\n  \"globalCode\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"imageId\": 123,\n  \"conditions\": {}\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.patch("https://api.oneofnone.io/v1/rewards/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"value\": 50000000,\n  \"minimumPurchase\": 1,\n  \"minimumQuantity\": 1,\n  \"usageLimitTotal\": 1,\n  \"usageLimitPerCustomer\": 1,\n  \"startsAt\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"stackable\": true,\n  \"globalCode\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"imageId\": 123,\n  \"conditions\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.oneofnone.io/v1/rewards/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"value\": 50000000,\n  \"minimumPurchase\": 1,\n  \"minimumQuantity\": 1,\n  \"usageLimitTotal\": 1,\n  \"usageLimitPerCustomer\": 1,\n  \"startsAt\": \"<string>\",\n  \"expiresAt\": \"<string>\",\n  \"stackable\": true,\n  \"globalCode\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"imageId\": 123,\n  \"conditions\": {}\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "value": 123,
  "minimumPurchase": 123,
  "minimumQuantity": 123,
  "usageLimitTotal": 123,
  "usageLimitPerCustomer": 123,
  "startsAt": "<string>",
  "expiresAt": "<string>",
  "stackable": true,
  "globalCode": "<string>",
  "externalUrl": "<string>",
  "imageId": 123,
  "conditions": {},
  "totalRedemptions": 123,
  "totalRevenueImpact": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "image": {
    "id": 123,
    "url": "<string>"
  },
  "externalIds": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rewardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "externalCodeId": "<string>",
      "syncedAt": "<string>",
      "error": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "access": {
    "qualifies": true,
    "reasons": [
      "<string>"
    ]
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

Getting Started

Access API

Activities API

Analytics API

Collections API

Collection Data API

Form Submissions API

Layouts API

Registrations API

Rewards API

Short URLs API

Teams API

Users API

Authorizations

Path Parameters

Body

Response