Update a custom field

curl --request PUT \
  --url https://app.supercycle.com/api/v1/custom_fields/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>"
}
'

import requests

url = "https://app.supercycle.com/api/v1/custom_fields/{id}"

payload = { "value": "<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({value: '<string>'})
};

fetch('https://app.supercycle.com/api/v1/custom_fields/{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://app.supercycle.com/api/v1/custom_fields/{id}",
  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([
    'value' => '<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://app.supercycle.com/api/v1/custom_fields/{id}"

	payload := strings.NewReader("{\n  \"value\": \"<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://app.supercycle.com/api/v1/custom_fields/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.supercycle.com/api/v1/custom_fields/{id}")

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  \"value\": \"<string>\"\n}"

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

{
  "id": 123,
  "ownerId": 123,
  "ownerType": "Item",
  "definitionId": 123,
  "key": "<string>",
  "value": "<string>",
  "valueJson": "<unknown>"
}

{
  "errors": [
    "Image custom fields are not enabled for this shop"
  ]
}

{
  "errors": [
    "Invalid request body"
  ]
}

{
  "error": "Rate limit exceeded. Retry after 42 seconds."
}

PUT

custom_fields

{id}

Update a custom field

curl --request PUT \
  --url https://app.supercycle.com/api/v1/custom_fields/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>"
}
'

import requests

url = "https://app.supercycle.com/api/v1/custom_fields/{id}"

payload = { "value": "<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({value: '<string>'})
};

fetch('https://app.supercycle.com/api/v1/custom_fields/{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://app.supercycle.com/api/v1/custom_fields/{id}",
  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([
    'value' => '<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://app.supercycle.com/api/v1/custom_fields/{id}"

	payload := strings.NewReader("{\n  \"value\": \"<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://app.supercycle.com/api/v1/custom_fields/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.supercycle.com/api/v1/custom_fields/{id}")

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  \"value\": \"<string>\"\n}"

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

{
  "id": 123,
  "ownerId": 123,
  "ownerType": "Item",
  "definitionId": 123,
  "key": "<string>",
  "value": "<string>",
  "valueJson": "<unknown>"
}

{
  "errors": [
    "Image custom fields are not enabled for this shop"
  ]
}

{
  "errors": [
    "Invalid request body"
  ]
}

{
  "error": "Rate limit exceeded. Retry after 42 seconds."
}

Authorizations

Authorization

string

header

required

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

Path Parameters

integer

required

Numeric ID of the custom field.

Body

application/json

value

string

required

New value of the custom field. For an image field (beta, for shops with the improved custom fields; others get a 403), the keys of the images to keep and the signedIds of new uploads, comma-separated in display order.

Response

Custom field updated successfully

integer<int64>

required

Numeric ID of the custom field.

ownerId

integer<int64>

required

ID of the item or rental that owns this custom field.

ownerType

enum<string>

required

Type of the owner resource. Rental is the legacy spelling of Cycle, returned only for rows created before the Rental -> Cycle data backfill.

Available options:

Item,

Cycle,

Rental

definitionId

integer<int64>

required

ID of the custom field definition.

key

string

required

Key of the custom field definition.

value

string

required

Raw stored value of the custom field.

valueJson

any

Typed JSON value of the custom field (format depends on definition type). An image field gives { key, filename, contentType, byteSize, url, thumbnailUrl } per image (an array when the definition is a list); url and thumbnailUrl are signed and expire after an hour, and thumbnailUrl is null until the thumbnail has been generated. Image fields are in beta (see CustomFieldDefinition.type).

Getting started

Conditions

Locations

AvailabilityTimelines

BlockedDates

CustomFieldDefinitions

CustomFields

Items

Products

Cycles

Rentals

ReturnOrders

TimelineComments

Update a custom field

Authorizations

Path Parameters

Body

Response