Create custom field

POST

/space/custom_field

const url = 'https://api.aelyst.ai/v1/space/custom_field';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"notes","description":"The internal notes about this customer","dataType":"text"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.aelyst.ai/v1/space/custom_field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "notes", "description": "The internal notes about this customer", "dataType": "text" }'

Create a new custom field

Authorizations

BearerAuth

Request Body

application/json

object

name

required

string

<= 50 characters

slug

The unique identifier for API and integrations. Field ID cannot be edited once added. Only letters, numbers, and underscores are allowed for this field.

string

nullable <= 50 characters

description

string

<= 255 characters

dataType

required

string

Allowed values: text list checkbox email number url date time

allowedValues

Only to be provided when the value of dataType is list

Array<string>

nullable

Examples

{
  "name": "notes",
  "description": "The internal notes about this customer",
  "dataType": "text"
}

{
  "name": "Fruits",
  "description": "The type of fruits we have",
  "dataType": "list",
  "allowedValues": [
    "Apple",
    "Banana",
    "Mango"
  ]
}

{
  "name": "Order Number",
  "description": "The order number of customer",
  "dataType": "number"
}

{
  "name": "New Customer",
  "description": "A flag to see if its a new customer.",
  "dataType": "checkbox"
}

Responses

200

application/json

object

required

Custom field ID.

integer

name

required

Name of the custom field.

string

description

required

string

dataType

required

Type of the data stored in this custom field.

string

Allowed values: text list checkbox email number url date time

allowedValues

List of enum values allowed to be stored in this field. This property is applicable only if the dataType is list.

Array<string>

Example

{
  "id": 123,
  "name": "customer_id",
  "description": "Customer ID",
  "dataType": "text"
}

400

application/json

object

code

integer

message

string

Example

{
  "code": 400,
  "message": "Validation error."
}

401

application/json

object

code

integer

message

string

Example

{
  "code": 401,
  "message": "UN_AUTHORIZED"
}

429

application/json

object

code

integer

message

string

Example

{
  "code": 429,
  "message": "Too Many Requests"
}

Headers

Retry-After

number

Example

Number of seconds until you can retry the request

X-RateLimit-Limit

number

Example

Number of request allowed for this end point

X-RateLimit-Remaining

number

Example

Number of request remaining for this end point

500

application/json

object

code

integer

message

string

Example

{
  "code": 500,
  "message": "Unexpected error occurred"
}