Create a custom field

POST

/api/v1/custom-fields

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/custom-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "entity_type": "lead", "label": "example", "type": "text", "choices": [ "example" ], "is_required": true, "is_shared": true, "order": 1, "default_value": "example", "editable_role_ids": [ "example" ] }'

The field_key used in record payloads is derived from label. entity_type and type cannot be changed later.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

entity_type

required

string

Allowed values: lead contact opportunity activity

label

required

string

>= 1 characters <= 200 characters

type

required

string

Allowed values: text number date boolean choice multi_choice rich_text url email phone

choices

Array<string>

is_required

boolean

is_shared

boolean

order

number

default_value

editable_role_ids

Array<string>

Responses

201

The new custom field

Media typeapplication/json

object

custom_field

required

object

_id

required

string

entity_type

required

string

Allowed values: lead contact opportunity activity

label

required

string

field_key

required

string

type

required

string

choices

required

Array<string>

is_required

required

boolean

is_shared

required

boolean

order

required

number

key

additional properties

any

Example

{
  "custom_field": {
    "entity_type": "lead"
  }
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Feature not available on the organization plan

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}