v1

latestOpenAPI 3.0.02026-07-13103151174.7 KB

Custom Properties

Create Custom Property

Create a new Custom Property

post/v1/projects/{project}/customProperties

Path parameters

projectstring required

A Project key or ID

Request body

namestring required

Display name for Custom Property.

keystring required

Auto generated key to be used by the API to reference by 'key' rather then _id for CRUD operations. Must only contain lower-case characters and _, - or ..

type'String' | 'Boolean' | 'Number' required

Type of the Custom Propety. Must be one of: "Boolean", "Number" or "String"

propertyKeystring required

Custom Property key, must be unique by Project. Only to be used by the SDKs to reference the Custom Property..

Example request

{
  "name": "Delivery App",
  "key": "delivery-app",
  "type": "String",
  "propertyKey": "Delivery App Secret Agent Code"
}

Response

namestring required

Display name for Custom Property.

keystring required

Auto generated key to be used by the API to reference by 'key' rather then _id for CRUD operations. Must only contain lower-case characters and _, - or ..

_idstring required

A unique CustomProperty ID

_projectstring required

The Project owning the Custom Property

_createdBystring required

ID of the User who created the project

propertyKeystring required

Custom Property key, must be unique by Project. Only to be used by the SDKs to reference the Custom Property..

type'String' | 'Boolean' | 'Number' required

The Custom Property type

createdAtstring date-time required

The date the Project was created

updatedAtstring date-time required

The date the Project was last updated

hasUsageboolean

Whether the custom property is in use by a feature

Example response

{
  "name": "Delivery App",
  "key": "delivery-app",
  "_id": "61450f3daec96f5cf4a49946",
  "propertyKey": "Delivery App Secret Agent Code",
  "type": "String",
  "hasUsage": true
}