Create Field

Create Field

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/crm/fields \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "entity": "<string>",
  "label": "<string>",
  "field_type": "<string>",
  "key": "<string>",
  "options": [
    "<string>"
  ]
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/crm/fields"

payload = {
    "entity": "<string>",
    "label": "<string>",
    "field_type": "<string>",
    "key": "<string>",
    "options": ["<string>"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entity: '<string>',
    label: '<string>',
    field_type: '<string>',
    key: '<string>',
    options: ['<string>']
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/crm/fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{}

POST

api

crm

fields

Create Field

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/crm/fields \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "entity": "<string>",
  "label": "<string>",
  "field_type": "<string>",
  "key": "<string>",
  "options": [
    "<string>"
  ]
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/crm/fields"

payload = {
    "entity": "<string>",
    "label": "<string>",
    "field_type": "<string>",
    "key": "<string>",
    "options": ["<string>"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entity: '<string>',
    label: '<string>',
    field_type: '<string>',
    key: '<string>',
    options: ['<string>']
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/crm/fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{}

Authorizations

X-API-Key

string

header

required

Body

application/json

entity

string

required

company, contact or deal

label

string

required

field_type

string

required

text, long_text, number, currency, date, boolean, select, multi_select, url or email

key

string | null

Generated from the label when omitted; immutable

options

string[] | null

Response

201 - application/json

Created

The response is of type Response · object.

Overview

Endpoints

Authorizations

Body

Response