Skip to main content
POST
/
v1
/
custom-fields
Create custom field
curl --request POST \
  --url https://api.timelyai.com.br/v1/custom-fields \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "options": [
    "<string>"
  ],
  "required": false
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "options": [
      "<string>"
    ],
    "required": true,
    "archived": true,
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

API key obtained from the dashboard

Body

application/json
​
name
string
required
Required string length: 1 - 100
​
type
enum<string>
required
Available options:
text,
number,
date,
boolean,
select,
multiselect
​
description
string
Maximum string length: 500
​
options
string[]
​
required
boolean
default:false

Response

Field created

​
data
object