Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Team Features

Add Custom Field

Creates a new lead-level custom field on the caller's team.

Notes:

  • attributeName is required and is trimmed; empty names are rejected.
  • attributeType is required. Supported types: text, number, date, anniversary_date, single_select, multi_select, percentage, currency.
    • anniversary_date: a date field that recurs annually (e.g. birthdays, work anniversaries). Accepts the same date format as date.
  • The response body is a plain string message.
post/v1.0/teamFeatures/custom-field

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

attributeNamestring required

The name of this custom field

attributeTypestring required

The type of the field

valuestring required

The content of the field for lead, value for multi-select,such as "["item1","item2\s",...]" .It's unnecessary when adding a new custom field for team

paramsstring

options for select, such as {"option":["item1","item2",...]}

Example request

{
  "attributeType": "number, text, date, anniversary_date, single_select, multi_select, percentage, currency"
}

Response

Custom field created.

string required

Example response

"success"