Skip to main content
POST
/
v1
/
upsell_funnels
Create
curl --request POST \
  --url https://{defaultHost}/v1/upsell_funnels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "upsell_funnel": {
    "name": "Awesome Upsell"
  }
}
'
import requests

url = "https://{defaultHost}/v1/upsell_funnels"

payload = { "upsell_funnel": { "name": "Awesome Upsell" } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({upsell_funnel: {name: 'Awesome Upsell'}})
};

fetch('https://{defaultHost}/v1/upsell_funnels', 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://{defaultHost}/v1/upsell_funnels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'upsell_funnel' => [
'name' => 'Awesome Upsell'
]
]),
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://{defaultHost}/v1/upsell_funnels"

payload := strings.NewReader("{\n \"upsell_funnel\": {\n \"name\": \"Awesome Upsell\"\n }\n}")

req, _ := http.NewRequest("POST", 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.post("https://{defaultHost}/v1/upsell_funnels")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"upsell_funnel\": {\n \"name\": \"Awesome Upsell\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{defaultHost}/v1/upsell_funnels")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"upsell_funnel\": {\n \"name\": \"Awesome Upsell\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "62e4cc10-f0b5-4694-90a4-c3efc2633eb0",
  "object": "upsell_funnel",
  "archived": false,
  "archived_at": null,
  "enabled": false,
  "filter_match_type": null,
  "filter_price_ids": [],
  "filter_product_ids": [],
  "metadata": {},
  "name": "Awesome Upsell",
  "priority": 5,
  "discarded_at": null,
  "created_at": 1782485915,
  "updated_at": 1782485915
}

Authorizations

Authorization
string
header
required

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

Body

application/json
upsell_funnel
object

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

archived
boolean

Whether or not this upsell funnel is archived.

enabled
boolean

Whether or not this upsell funnel is enabled.

filter_match_type
string | null

The matching strategy to use when filtering upsell funnels – can be null or one of all, any, none. If null, the upsell funnel will not be filtered and will be applicable to all checkouts.

filter_price_ids
array

The prices to filter this upsell funnel by.

filter_product_ids
array

The products to filter this upsell funnel by.

name
string | null

A name for this upsell that will be visible to customers.

priority
integer

The priority of this upsell in relation to other upsells. Must be in the range of 1 - 5 with 5 being the highest priority and 1 being the lowest.

metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

archived_at
integer | null

Time at which the object was archived. Measured in seconds since the Unix epoch.

upsells

Expandable – Property not returned unless expanded.

discarded_at
integer | null

Time at which the object was discarded. Measured in seconds since the Unix epoch.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.