Attributes
Create an attribute
Creates a new attribute on either an object or a list.
To create an attribute on an object, you must also have the object_configuration:read-write scope.
To create an attribute on a list, you must also have the list_configuration:read-write scope.
post/v2/{target}/{identifier}/attributes
Path parameters
target'objects' | 'lists' required
Whether the attribute is to be created on an object or a list.
Example:lists
identifierstring required
A UUID or slug to identify the object or list the attribute belongs to.
Example:97052eb9-e65e-443f-a297-f2d9a4a7f795
Request body
Example request
{
"data": {
"title": "Your Attribute",
"description": "Lorem ipsum",
"api_slug": "my-attribute",
"type": "text",
"is_required": true,
"is_unique": true,
"is_multiselect": true,
"default_value": {
"type": "dynamic",
"template": "current-user"
},
"config": {
"currency": {
"default_currency_code": "USD",
"display_type": "symbol"
},
"record_reference": {
"allowed_objects": [
"people"
]
}
}
}
}Response
Success
Example response
{
"data": {
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
"attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"
},
"title": "Rating",
"description": "Rating of the record out of 5",
"api_slug": "Rating",
"type": "rating",
"is_system_attribute": false,
"is_writable": true,
"is_required": false,
"is_unique": false,
"is_multiselect": false,
"is_default_value_enabled": false,
"is_archived": false,
"default_value": null,
"relationship": null,
"created_at": "2021-11-21T13:22:49.061Z",
"config": {
"currency": {
"default_currency_code": null,
"display_type": null
},
"record_reference": {
"allowed_object_ids": null
}
}
}
}