POST
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
Create Custom Attribute
curl --request POST \
  --url https://api.zixflow.com/api/v1/attributes/{target}/{targetId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "apiKeyName": "<string>",
  "inputType": "<string>",
  "name": "<string>",
  "config": {
    "currencyDisplayType": "<string>",
    "currencyCode": "<string>",
    "recordReference": {},
    "aiWizard": "<string>",
    "dateDisplayType": "<string>"
  },
  "defaultValue": "<string>",
  "description": "<string>",
  "isEditable": true,
  "isMultiSelect": true,
  "isRequired": true,
  "isUnique": true,
  "validation": "<string>"
}'
{
    "status": true,
    "message": "success",
    "data": {
        "_id": "64ad815b273e66dae1afe10f",
        "apiKeyName": "name",
        "inputType": "text",
        "name": "Name",
        "config": {
            "currencyDisplayType": null,
            "currencyCode": null,
            "recordReference": [],
            "aiWizard": null,
            "dateDisplayType": null
        },
        "defaultValue": null,
        "description": "",
        "isEditable": true,
        "isMultiSelect": false,
        "isRequired": false,
        "isUnique": false,
        "validation": "none"
    }
}

​
Description

This API endpoint allows the creation of a new attribute within a specified target, either a collection or a list. Attributes define the nature and characteristics of the data stored within the target.

​
Path

​
target
string
required

Specifies the target type, which can be either “collection” or “list.”

​
targetId
string
required

A unique identifier for the target, either a collection ID or a list ID, depending on the target type.

​
Body

​
apiKeyName
string
required

The API key name used to store data in the collection or list for this field.

​
inputType
string
required

Defines the input type or nature of the field. Possible values include text, number, checkbox, currency, date, timestamp, rating, status, select, multiselect, record-reference, actor-reference, domain, file, ai-wizard, email-address, phone-number.

​
name
string
required

The human-readable name of the field.

​
config
object
required

Configuration settings for the attribute, including currency display type, currency code, record reference, AI wizard, and date display type.

​
defaultValue
string

The default value for the attribute.

​
description
string

A description providing additional information about the attribute.

​
isEditable
boolean

Indicates whether the attribute is editable (true/false).

​
isMultiSelect
boolean

Indicates whether the attribute supports multiple selections (true/false).

​
isRequired
boolean

Indicates whether the attribute is required (true/false).

​
isUnique
boolean

Indicates whether the attribute values must be unique (true/false).

​
validation
string

The validation type for the attribute. Possible values include “none,” “email,” “url,” “phone,” “customRegex.”

​
Response

​
status
boolean

Indicates the success or failure of the attribute creation. In this case, true signifies a successful operation.

​
message
string

Provides a human-readable message accompanying the response. In this instance, it confirms the successful creation of the attribute.

​
data
object

An object containing details of the newly created attribute:

{
    "status": true,
    "message": "success",
    "data": {
        "_id": "64ad815b273e66dae1afe10f",
        "apiKeyName": "name",
        "inputType": "text",
        "name": "Name",
        "config": {
            "currencyDisplayType": null,
            "currencyCode": null,
            "recordReference": [],
            "aiWizard": null,
            "dateDisplayType": null
        },
        "defaultValue": null,
        "description": "",
        "isEditable": true,
        "isMultiSelect": false,
        "isRequired": false,
        "isUnique": false,
        "validation": "none"
    }
}