PUT
/
v1
/
custom-properties
/
{id}

Authorizations

​
Authorization
string
headerrequired

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
Available options:
customer,
product,
plan,
quote,
subscription
​
api_only
boolean | null
default: false
​
authorized_values
string[] | null

Response

201 - application/json
​
id
string
required

Custom property ID.

​
name
string
required

Custom property name.

​
slug
string
required

Custom property unique slug.

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

Available options:
customer,
product,
plan,
quote,
subscription
​
authorized_values
string[] | null
required

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

​
api_only
boolean
default: falserequired

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

​
created_at
string
required

Creation date of the custom property.

​
updated_at
string
required

Update date of the custom property.

Was this page helpful?

Create custom propertyDelete custom property