Skip to main content
POST
/
v1
/
custom-fields
Create a custom field
curl --request POST \
  --url https://api.vendaze.com/v1/custom-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "Market Segment",
  "key": "market_segment",
  "value": "<string>",
  "required": true,
  "show_people": true,
  "show_companies": true,
  "show_deals": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "Market Segment",
    "key": "market_segment",
    "type": "select",
    "value": "[\"SaaS\",\"E-commerce\",\"Finance\"]",
    "required": false,
    "show_people": true,
    "show_companies": true,
    "show_deals": false,
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth 2.1 access token.

Body

application/json
​
label
string
required
Maximum string length: 40
Example:

"Market Segment"

​
key
string
required
Maximum string length: 35
Example:

"market_segment"

​
type
enum<string>
required
Available options:
text,
long_text,
select,
multi_select,
cpf,
cnpj,
date,
number,
link,
address
​
value
string

Options array for select/multi_select fields; null for others.

​
required
boolean
​
show_people
boolean
​
show_companies
boolean
​
show_deals
boolean

Response

Custom field created successfully.

​
data
object