Create custom field

POST

https://api.talktohumans.app

custom-fields

curl --request POST \
  --url https://api.talktohumans.app/v1/custom-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "ICP score",
  "field_type": "number"
}
'

{
  "data": {
    "custom_field": {
      "id": "8f3a2c1d4b5e4f6a9b7c0d1e2f3a4b5c",
      "name": "ICP score",
      "field_type": "number",
      "object_type": "contact"
    }
  }
}

Authorizations

Authorization

string

header

required

Pass API key as Authorization: Bearer <api_key>.

Body

application/json

name

string

required

Field name shown in TalkToHumans. Must be unique per object type.

Minimum string length: 1

field_type

enum<string>

required

Value type. It can't be changed later.

Available options:

text,

number,

boolean,

date

object_type

enum<string>

default:contact

Available options:

contact,

company

Response

Custom field created.

data

object

required

Show child attributes

curl --request POST \
  --url https://api.talktohumans.app/v1/custom-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "ICP score",
  "field_type": "number"
}
'

{
  "data": {
    "custom_field": {
      "id": "8f3a2c1d4b5e4f6a9b7c0d1e2f3a4b5c",
      "name": "ICP score",
      "field_type": "number",
      "object_type": "contact"
    }
  }
}

Conversations

Templates

Contacts

Companies

Custom fields

Enrich

Views

Accounts

Activity

Authorizations

Body

Response