Add Attribute to Schema

post

https://{hostname}/api/custom-entity/v1/schema-attributes

Query Params

schemaName

string

required

Body Params

fieldName

string

required

length ≤ 100

name

string

required

length between 1 and 255

nameKey

string

length ≤ 255

description

string

length ≤ 1000

descriptionKey

string

length ≤ 255

required

boolean

Defaults to false

allowOther

boolean

Defaults to false

responseType

string

enum

required

optionType

string

enum

length ≤ 50

Defaults to None

Allowed:

options

array of objects

options

referenceCategoryIds

array of uuids

referenceCategoryIds

formula

string

length ≤ 4000

context

object

source

string

length ≤ 50

responseSubType

string

enum

Allowed:

associatedAttributeRequest

object

maxMultiSelectAllowedOptionValues

int32

1 to 100

encrypted

boolean

Defaults to false

metadata

string

intakeQuestion

object

validationRuleId

string

length ≤ 255

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

*/*