Custom Data

Add an entity custom allowed property

This call will add a new custom data property to the current entity. The property will be available for all documents created in the entity.

key is 1 to 100 characters long and may contain only letters, numbers, curly brackets, dots, dashes and underscores (^[-a-zA-Z0-9._{}]{1,100}$). A setValues property takes 1 to 10 options, each with a unique key that follows the same rules.

post/v1/custom-data/entity

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/custom-data/entity
  • Auth: HTTP bearer

Request body

keystring required

Unique key for the custom data property. Must be unique within the entity and may contain letters, numbers, curly brackets, dots, dashes and underscores.

value_type'string' | 'number' | 'boolean' | 'setValues' required

Type of value the property accepts on a document.

labelstring

Deprecated. Use translations instead. When provided without translations, the label is stored as a single translation for the entity default language.

Response

The resource was created.

entity_idstring required

Id of the entity the custom data settings belong to.

Changes

No recorded changes to this operation across all 1 revision of this API.