Skip to main content
POST
Register property
Required scopes: properties.configuration:rw

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
name
string
required

The property name.

owner_client_id
string
required

The Client Id that will own the property. Must be owned by your organization.

type
enum<string>
required

The property type.

Available options:
int,
string,
bool,
tokenized_string
access
object
required

An object with location keys (chat, thread, event, license, group) and their access configuration.

description
string

The property description.

domain
any[]

An array of values that the property can be set to. Only one of domain and range can be set for a single property.

range
object

A range of values that the property can be set to. Works only for numeric types.

default_value
any

The default value of the property. Validated by domain or range, if one exists. Registering a property with default_value is possible only if access.<location> is set to license or to group.

Response

200

Property registered successfully.