Update custom property

PUT

custom-properties

{id}

curl --request PUT \
  --url https://api.hyperline.co/v1/custom-properties/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "entities": [],
  "api_only": true,
  "required": true,
  "authorized_values": [
    "<string>"
  ],
  "default_value": "<string>"
}
'

import requests

url = "https://api.hyperline.co/v1/custom-properties/{id}"

payload = {
    "name": "<string>",
    "slug": "<string>",
    "entities": [],
    "api_only": True,
    "required": True,
    "authorized_values": ["<string>"],
    "default_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({
    name: '<string>',
    slug: '<string>',
    entities: [],
    api_only: true,
    required: true,
    authorized_values: ['<string>'],
    default_value: '<string>'
  })
};

fetch('https://api.hyperline.co/v1/custom-properties/{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.hyperline.co/v1/custom-properties/{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([
    'name' => '<string>',
    'slug' => '<string>',
    'entities' => [
        
    ],
    'api_only' => true,
    'required' => true,
    'authorized_values' => [
        '<string>'
    ],
    'default_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://api.hyperline.co/v1/custom-properties/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"entities\": [],\n  \"api_only\": true,\n  \"required\": true,\n  \"authorized_values\": [\n    \"<string>\"\n  ],\n  \"default_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://api.hyperline.co/v1/custom-properties/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"entities\": [],\n  \"api_only\": true,\n  \"required\": true,\n  \"authorized_values\": [\n    \"<string>\"\n  ],\n  \"default_value\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/custom-properties/{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  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"entities\": [],\n  \"api_only\": true,\n  \"required\": true,\n  \"authorized_values\": [\n    \"<string>\"\n  ],\n  \"default_value\": \"<string>\"\n}"

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

{
  "id": "cfi_efnjehRH304",
  "name": "Test custom property",
  "slug": "test_custom_property",
  "type": "date",
  "entities": [
    "customer"
  ],
  "authorized_values": [
    "<string>"
  ],
  "default_value": "standard",
  "created_at": "2024-01-01T22:00:00Z",
  "updated_at": "2024-01-01T22:00:00Z",
  "api_only": false,
  "required": false
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Body

application/json

name

string

required

type

enum<string>

required

Available options:

date,

boolean,

number,

text,

email,

select,

multi_select

slug

string

required

entities

enum<string>[]

required

Available options:

customer,

product,

plan,

quote,

subscription,

invoice

api_only

boolean | null

required

boolean | null

authorized_values

string[] | null

default_value

Value set on entities created without an explicit value for this custom property. On existing entities without a value, it also satisfies required. Must match the custom property type, and one of authorized_values for select and multi_select types. Dates are ISO 8601 strings. Email defaults must be valid email addresses. Null means no default value.

Response

201 - application/json

string

required

Custom property ID.

Example:

"cfi_efnjehRH304"

name

string

required

Custom property name.

Example:

"Test custom property"

slug

string

required

Custom property unique slug.

Example:

"test_custom_property"

type

enum<string>

required

Custom property type.

Available options:

date,

boolean,

number,

text,

email,

select,

multi_select

entities

enum<string>[]

required

Entities on which the custom property is available.

Available options:

customer,

product,

plan,

quote,

subscription,

invoice

authorized_values

string[] | null

required

If the custom property is of type select this is the list of available values.

default_value

required

Example:

"standard"

created_at

string<date-time>

required

Creation date of the custom property.

Example:

"2024-01-01T22:00:00Z"

updated_at

string<date-time>

required

Update date of the custom property.

Example:

"2024-01-01T22:00:00Z"

api_only

boolean

default:false

If true the custom property will not be displayed in the interface.

required

boolean

default:false

If true the custom property must be filled for every configured entity.

⌘I

Update custom property

curl --request PUT \
  --url https://api.hyperline.co/v1/custom-properties/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "entities": [],
  "api_only": true,
  "required": true,
  "authorized_values": [
    "<string>"
  ],
  "default_value": "<string>"
}
'

import requests

url = "https://api.hyperline.co/v1/custom-properties/{id}"

payload = {
    "name": "<string>",
    "slug": "<string>",
    "entities": [],
    "api_only": True,
    "required": True,
    "authorized_values": ["<string>"],
    "default_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({
    name: '<string>',
    slug: '<string>',
    entities: [],
    api_only: true,
    required: true,
    authorized_values: ['<string>'],
    default_value: '<string>'
  })
};

fetch('https://api.hyperline.co/v1/custom-properties/{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.hyperline.co/v1/custom-properties/{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([
    'name' => '<string>',
    'slug' => '<string>',
    'entities' => [
        
    ],
    'api_only' => true,
    'required' => true,
    'authorized_values' => [
        '<string>'
    ],
    'default_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://api.hyperline.co/v1/custom-properties/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"entities\": [],\n  \"api_only\": true,\n  \"required\": true,\n  \"authorized_values\": [\n    \"<string>\"\n  ],\n  \"default_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://api.hyperline.co/v1/custom-properties/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"entities\": [],\n  \"api_only\": true,\n  \"required\": true,\n  \"authorized_values\": [\n    \"<string>\"\n  ],\n  \"default_value\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/custom-properties/{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  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"entities\": [],\n  \"api_only\": true,\n  \"required\": true,\n  \"authorized_values\": [\n    \"<string>\"\n  ],\n  \"default_value\": \"<string>\"\n}"

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

{
  "id": "cfi_efnjehRH304",
  "name": "Test custom property",
  "slug": "test_custom_property",
  "type": "date",
  "entities": [
    "customer"
  ],
  "authorized_values": [
    "<string>"
  ],
  "default_value": "standard",
  "created_at": "2024-01-01T22:00:00Z",
  "updated_at": "2024-01-01T22:00:00Z",
  "api_only": false,
  "required": false
}