PUT
/
v1
/
custom-properties
/
{id}
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>",
  "type": "date",
  "slug": "<string>",
  "entities": [
    "customer"
  ],
  "api_only": false,
  "authorized_values": [
    "<string>"
  ]
}'
{
  "id": "cfi_efnjehRH304",
  "name": "Test custom property",
  "slug": "test_custom_property",
  "type": "date",
  "entities": [
    "customer"
  ],
  "authorized_values": [
    "<string>"
  ],
  "api_only": false,
  "created_at": "2024-01-01T22:00:00Z",
  "updated_at": "2024-01-01T22:00:00Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

application/json
​
name
string
required
​
type
enum<string>
required
Available options:
date,
boolean,
number,
text,
select
​
slug
string
required
​
entities
enum<string>[]
required
​
api_only
boolean | null
default:false
​
authorized_values
string[] | null

Response

201 - application/json
​
id
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,
select
​
entities
enum<string>[]
required

Entities on which the custom property is available.

​
authorized_values
string[] | null
required

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

​
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.